← Back to schema index

ValidateAccountResource

JSON:API resource carrying the structural validation result for the account.

Properties

FieldTypeDescription
type*stringJSON:API resource type. Always `account_validation`.
attributes*objectStructural validation result.
input*stringRaw input as received (un-normalized).
length*integerLength in digits of the normalized input.
is_numeric*boolean`true` when the raw input contained only digits (no separators).
account_type*stringAccount type detected by length, or `unknown` for partial inputs or out-of-range lengths. The recognised types are `clabe`, `card`, and `phone`.
is_complete*boolean`true` when the input is complete for its type (18 digits for CLABE, 16 for card, 10 for phone).
checksum_valid*boolean`true` when the CLABE control digit verifies, or the card Luhn checksum is valid. For phone always `false` (not applicable).
computed_control_digitstring | nullCLABE control digit computed from the first 17 digits. `null` when the type is not CLABE or the calculation does not apply.
auto_completedstring | null18-digit auto-completed CLABE when the input arrived with 17 digits and the control digit could be calculated. `null` otherwise.
bankobject | nullResolved bank metadata, or `null` when the bank could not be identified. For CLABE derived from the prefix; for card derived from the BIN.
banxico_codestring | null5-digit Banxico SPEI code when the bank is mapped.
namestringBank name.
cardobject | nullAdditional BIN metadata when `account_type=card` and the BIN matched the directory. `null` otherwise.
binstringQueried BIN prefix.
brandstring | nullCard brand (Visa, Mastercard, etc.).
typestring | nullCard type (`debit`, `credit`, etc.).
levelstring | nullCard level (`classic`, `gold`, etc.).
country_isostring | nullISO 3166-1 alpha-2 of the issuing country.

Used in operations

  • GET /v1/beneficiaries/validate-account

Referenced by schemas