Skip to navigation
API BaaSAccounts

Find the tenant's accounts by document

Returns every account of the tenant in X-Tenant-Id whose holder document matches document. One CPF or CNPJ can have more than one account, so the result is a list, not a single account. Masks are accepted (123.456.789-00); matching uses the digits only.

An empty items array is a successful response. This route does not answer 404 for an unknown document.

Not paginated: a document has a handful of accounts. Requires the read scope, and a credential restricted to specific accounts only sees those. Does not include balances.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.

Query parameters

documentstringRequired

Holder CPF (11 digits) or CNPJ (14 digits). Punctuation is ignored.

Response

The accounts of that document in this tenant. items is empty when there are none.

tenantIdstring

Tenant from X-Tenant-Id.

documentstring
Digits of the document that was searched, without punctuation.
itemslist of objects

Matching accounts. Empty when the document has no account in this tenant; that is not an error.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error