← Back to schema index

BeneficiaryLookupResource

JSON:API resource carrying the resolved beneficiary account for the user.

Properties

FieldTypeDescription
type*stringJSON:API resource type. Always `beneficiary_lookup`.
attributes*objectResolved account metadata.
account_number*stringAccount number the lookup was made with, whether CLABE, card, or DiMo phone.
account_type*stringAccount type auto-detected at registration. `clabe`: 18-digit CLABE; `card`: 16-digit card; `phone`: 10-digit phone.
bank_code*stringSPEI code (5 digits) of the resolved bank. It is the empty string (`""`) for a card whose BIN is not in the directory.
bank_name*stringOfficial name of the bank, resolved from its `bank_code`.
labelstring | nullFree-form label, `null` when none was assigned.

Used in operations

  • GET /v1/beneficiaries/lookup

Referenced by schemas