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.
multipleAccounts is true when the document has more than one active
account (same CorpX count as the by-document guard, or 2+ usable
accounts on the partner holder). false when the count answered and
there is at most one. Omitted when the count could not be confirmed —
the preview still returns; callers that need a single destination must
not treat an absent flag as “only one account”.
Use this endpoint to let the user confirm the recipient before calling
POST /v1/accounts/{accountId}/transfers/internal/by-document.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
CPF (11 digits) or CNPJ (14 digits) of the recipient.
Headers
Response
Recipient found. Returns a privacy-preserving preview plus branch and account number.
Holder name with privacy mask: first name in full, remaining surnames reduced to first letter + ”***”.
Same value as maskedName. Kept so existing parsers of this field keep working.
Fully masked document shape. CPF → ***.***.***-**,
CNPJ → ***.***.***/****-**. Digits are never returned in the body.
Settlement-bank branch of the first matching account.
Settlement-bank account number of the first matching account.
true when the document has more than one active account
(CorpX count used by by-document, or 2+ usable accounts
on the partner holder). false when the count answered
and there is at most one. Omitted when the count failed —
do not treat absence as “single account”.