SHshinkansen
Account Validation

Returns a validation batch

Returns the batch and every validation request it contains, in their current state. Requests that are not pending include their response. Useful to check a batch whose webhook you did not receive.

get/validation/batches/{validation_batch_id}

Request

  • Base URL
    https://api.validator.shinkansen.finance/v1
  • URL
    https://api.validator.shinkansen.finance/v1/validation/batches/{validation_batch_id}
  • Auth
    API key in header Shinkansen-Validator-Api-Key

Response

Validation batch found.

idstring required

The id of the validation batch, as you sent it.

source_type'api' | 'file' | 'other' required

How the batch was created: api through this endpoint, file or other through the Shinkansen Dashboard.

source_namestring required
status'pending' | 'performed' required

The status of the batch as a whole:

  • pending while at least one of its validation requests is pending.
  • performed once none is pending. Shinkansen checks batches every minute, so a batch is closed up to a minute after its last result. Requests that failed or timed out count as finished.
timeout_atstring date-time nullable

When the batch times out (batches created through this endpoint only). Requests still pending at that time are closed as error, with return_code unable_to_validate and return_message batch_timed_out.

closed_atstring date-time nullable

When the batch changed to performed. null while pending.

inserted_atstring date-time required
updated_atstring date-time required

Example response

{
  "validation_requests": [
    {
      "id": "3c11df48-dfab-41eb-a3c1-b9f90a0da063",
      "account_details": {
        "name": "Romulo Gallegos",
        "identification": {
          "id_schema": "CLID",
          "id": "12383287-6"
        },
        "financial_institution": {
          "fin_id_schema": "SHINKANSEN",
          "fin_id": "SCOTIABANK_CL"
        },
        "account": "1513523451",
        "account_type": "current_account",
        "currency": "CLP",
        "email": "romulo.gallegos@shinkasen.finance"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.