Contacts

GET /v2/contacts

List contacts

Parameters

Parameter	In	Type	Required	Description
page	query	integer	no	Default: 1.
limit	query	integer	no	Default: 25.
type	query	INTERNAL | EXTERNAL_CRYPTO | BANK_ACCOUNT	no	Filter by contact type.

Responses

Code	Description	Body
200	Success.	data: ContactResource[] · pagination: PaginationMeta
401	application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).	—
403	application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).	—
429	application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).	—
500	application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).	—
502	application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).	—
503	application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).	—

---

GET /v2/contacts/{contactId}

Get a contact by id

Parameters

Parameter	In	Type	Required	Description
contactId	path	string	yes

Responses

Code	Description	Body
200	Success.	ContactResource
401	application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).	—
403	application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).	—
404	application/problem+json (RFC 9457) — branch on code, not on the status: not_found (not retryable).	—
429	application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).	—
500	application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).	—
502	application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).	—
503	application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).	—

---

PATCH /v2/contacts/{contactId}

Edit a contact's reference/alias

Parameters

Parameter	In	Type	Required	Description
contactId	path	string	yes

Request body — UpdateContactReferenceDto

Responses

Code	Description	Body
200	Success.	ContactResource
400	application/problem+json (RFC 9457) — branch on code, not on the status: validation_error (not retryable).	—
401	application/problem+json (RFC 9457) — branch on code, not on the status: unauthorized (not retryable), key_expired (not retryable), key_revoked (not retryable).	—
403	application/problem+json (RFC 9457) — branch on code, not on the status: insufficient_scope (not retryable), ip_not_allowed (not retryable), api_access_disabled (not retryable).	—
404	application/problem+json (RFC 9457) — branch on code, not on the status: not_found (not retryable).	—
422	application/problem+json (RFC 9457) — branch on code, not on the status: unprocessable (not retryable).	—
429	application/problem+json (RFC 9457) — branch on code, not on the status: rate_limited (retryable).	—
500	application/problem+json (RFC 9457) — branch on code, not on the status: internal_error (retryable).	—
502	application/problem+json (RFC 9457) — branch on code, not on the status: downstream_unavailable (retryable).	—
503	application/problem+json (RFC 9457) — branch on code, not on the status: maintenance (retryable).	—

---

Schemas

BankContactDetails

Field	Type	Description
assetSymbol	string | null	Asset this account settles in. Always a FIAT code — a bank account cannot be denominated in a crypto asset or a tokenised equity. e.g. CLP.
nationalId	string | null	The account holder's national id.
bankId	string | null
bankName	string | null	e.g. Banco de Chile.
accountTypeId	string | null
bankAccountType	string | null	e.g. CHECKING.
bankAccountNumber	string | null
accountEmail	string | null

ContactResource

Field	Type	Description
id	string
reference	string | null
type	INTERNAL | EXTERNAL_CRYPTO | BANK_ACCOUNT	Which kind of destination this is, and therefore which detail block is present: EXTERNAL_CRYPTO → crypto, BANK_ACCOUNT → bank, INTERNAL → neither.
alias	string
createdAt	string
updatedAt	string
crypto (optional)	any	Present only when type is EXTERNAL_CRYPTO.
bank (optional)	any	Present only when type is BANK_ACCOUNT.

CryptoContactDetails

Field	Type	Description
assetSymbol	string | null	Asset code this address receives. e.g. BTC.
assetName	string | null	e.g. Bitcoin.
networkSymbol	string | null	Network the address lives on. e.g. BTC.
networkName	string | null	e.g. Bitcoin.
address	string | null	The on-chain destination address.
tag	string | null	Destination tag / memo, for chains that require one (XRP, XLM…). Null otherwise.

PaginationMeta

Field	Type	Description
page	number	e.g. 1.
limit	number	e.g. 25.
totalItems	number	e.g. 100.
totalPages	number	e.g. 4.

Problem

Field	Type	Description
type	string	Stable problem-type URI. Resolves to docs for this error. e.g. https://docs.skipo.com/errors/rate_limited.
title	string	Short, human-readable summary (stable, English). e.g. Rate limit exceeded.
status	number	HTTP status code. e.g. 429.
code	string	Stable machine-readable error code (equals the last path segment of type). e.g. rate_limited.
retryable	boolean	Whether retrying the identical request may succeed. e.g. true.
detail (optional)	string	Human-readable, possibly localized detail.
instance (optional)	string	The request path that produced the error.
traceId (optional)	string	Trace id — joins BigQuery api_request and Cloud Logging.

UpdateContactReferenceDto

Field	Type	Description
reference	string	New reference/alias label for the contact (does not change the destination).

---

Back to the endpoint reference. See also: Pagination · Errors · Ids and correlation.