Skip to main content
GET
Get counterparty checks

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer the recipient belongs to. Must be a cus_… reference id — a UUID is rejected with 400.

recipientId
string
required

The recipient. Must be a rec_… reference id — a UUID is rejected with 400.

Response

The recipient's provider-side state, read with no side effects. Unwrapped.

status
string

OPEN, ACTIVE, CLOSED, FROZEN, PENDING, EDD, DORMANT, and the _L2F variants. Treat the set as open and compare case-insensitively — only ACTIVE means ready.

counterpartyId
string

The provider-side counterparty.

addedToAccountsProvider
any

Whether the recipient has been registered at the provider.

statusUpdatedOn
any

When status last changed.