API BaaSInternal Transfers

Lookup internal transfer recipient by document

Returns a privacy-preserving preview of the recipient for confirmation before executing an internal transfer by document. Only the first name is returned in full; remaining surnames are reduced to their first letter followed by "***". Example: `"JOHN SILVA DOE"` → `"JOHN S*** D***"` `holderDocument` is fully masked (CPF/CNPJ shape with no digits). `branch`, `accountNumber`, and `accountStatus` of the first matching account are included. Use this endpoint to let the user confirm the recipient before calling `POST /v1/accounts/{accountId}/transfers/internal/by-document`.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired
Account identifier.
documentstringRequired

CPF (11 digits) or CNPJ (14 digits) of the recipient.

Headers

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

Response

Recipient found. Returns a privacy-preserving preview plus branch and account number.

maskedNamestring

Holder name with privacy mask: first name in full, remaining surnames reduced to first letter + ”***”.

holderNamestring

Same value as maskedName. Kept so existing parsers of this field keep working.

holderDocumentstring

Fully masked document shape. CPF → ***.***.***-**, CNPJ → ***.***.***/****-**. Digits are never returned in the body.

branchstring

Settlement-bank branch of the first matching account.

accountNumberstring

Settlement-bank account number of the first matching account.

accountStatusstringOptional
Account status at the banking partner.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error