Contacts

GET /v2/contacts

List contacts

Parámetros

Parámetro	En	Tipo	Requerido	Descripción
page	query	integer	no	Default: 1.
limit	query	integer	no	Default: 25.
type	query	INTERNAL | EXTERNAL_CRYPTO | BANK_ACCOUNT	no	Filter by contact type.

Respuestas

Código	Descripción	Cuerpo
200	Éxito.	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

Parámetros

Parámetro	En	Tipo	Requerido	Descripción
contactId	path	string	sí

Respuestas

Código	Descripción	Cuerpo
200	Éxito.	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

Parámetros

Parámetro	En	Tipo	Requerido	Descripción
contactId	path	string	sí

Cuerpo de la petición — UpdateContactReferenceDto

Respuestas

Código	Descripción	Cuerpo
200	Éxito.	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).	—

---

Esquemas

BankContactDetails

Campo	Tipo	Descripción
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. Ej.: CLP.
nationalId	string | null	The account holder's national id.
bankId	string | null
bankName	string | null	Ej.: Banco de Chile.
accountTypeId	string | null
bankAccountType	string | null	Ej.: CHECKING.
bankAccountNumber	string | null
accountEmail	string | null

ContactResource

Campo	Tipo	Descripción
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 (opcional)	any	Present only when type is EXTERNAL_CRYPTO.
bank (opcional)	any	Present only when type is BANK_ACCOUNT.

CryptoContactDetails

Campo	Tipo	Descripción
assetSymbol	string | null	Asset code this address receives. Ej.: BTC.
assetName	string | null	Ej.: Bitcoin.
networkSymbol	string | null	Network the address lives on. Ej.: BTC.
networkName	string | null	Ej.: 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

Campo	Tipo	Descripción
page	number	Ej.: 1.
limit	number	Ej.: 25.
totalItems	number	Ej.: 100.
totalPages	number	Ej.: 4.

Problem

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

UpdateContactReferenceDto

Campo	Tipo	Descripción
reference	string	New reference/alias label for the contact (does not change the destination).

---

Volver a la referencia de endpoints. Ver también: Paginación · Errores · Ids y correlación.