Banking verification parameters
Request and response parameters for verifying banking information through the Relish Data Assure API.
Bank validation input parameters
Parameters for bank validation within the validations array.
| Parameter | Required | Length | Type | Description |
|---|---|---|---|---|
| type | Yes | Varies | Enum | Validation type. Use bank for banking verification. |
| input | Yes | Varies | Object | Bank validation input object containing bank details. |
| externalId | Yes | Varies | String | Unique identifier for the bank validation. Must be unique across all validations of this type. |
| name | Yes | 1+ characters | String | Name of the financial institution to be validated. |
| iban | No | 1+ characters | String | International Bank Account Number (IBAN). |
| swiftCode | Conditional | 1+ characters | String | SWIFT code associated with the account. Required if routing number is not present. |
| routingNumber | Conditional | Varies | String | Routing number associated with the account. Required if SWIFT code is not present. |
| country | Yes | 2-3 characters | String | ISO 3166-1 alpha-2 or alpha-3 country code for the financial institution. |
Response parameters
Parameters returned in API responses for banking verification requests.
| Parameter | Type | Description |
|---|---|---|
| status | Enum | Transaction status: PENDING, PROCESSING, COMPLETED, or ERROR |
| result | Enum | Overall transaction result: PASSED, PASSED WITH CAUTIONS, FAILED, REVISION REQUIRED, or NOT VALIDATED |
| validationSummary | Array | Summary of results for each validation type. |
| validations | Array | Array of detailed validation results. |