Skip to main content
GET
Get Portfolio Item Snapshot

Authorizations

X-API-Key
string
header
required

Path Parameters

item_id
string<uuid>
required

The unique identifier of the portfolio item to get snapshot for.

Examples:

"412a49b5-7466-426b-bf1e-081b00b54576"

"9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5"

snapshot_id
string<uuid>
required

The unique identifier of the snapshot to retrieve.

Examples:

"412a49b5-7466-426b-bf1e-081b00b54576"

"9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5"

Response

Response

Represents a portfolio item snapshot response.

id
string<uuid>
required

The unique identifier of the snapshot.

portfolio_item_id
string<uuid>
required

The unique identifier of the portfolio item this snapshot belongs to.

schema_version
integer
required

The schema version of the snapshot data.

data
BusinessPortfolioItemSnapshotData (v1) · object
required

Represents the data of a business portfolio item snapshot.

created_at
string<date-time>
required

When the snapshot was created.

attributes
enum<string>[]

The attributes that were monitored when the snapshot was created.

The attributes that can be monitored.

Available options:
sos,
liens,
litigations,
bankruptcies,
website_analysis,
pep,
ofac,
identity_network