SHshinkansen
Account Validation

Request a batch of validations

Requests up to 1000 validations in a single call. Shinkansen stores the batch and answers immediately; the validations are performed asynchronously, and once none is pending the results of the whole batch are sent in a single call to the batch webhook configured for the Validator service. Validations that belong to a batch are not sent to the single validation webhook.

The batch is accepted or rejected as a whole: if any request is invalid, its id is taken or repeated, or it asks for an access check that is not available, nothing is stored.

A batch times out after 15 minutes by default. Requests still pending at that time are closed as error, with return_code unable_to_validate and return_message batch_timed_out.

post/validation/batches

Request

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

Request body

idstring required

The id of the validation batch. Set by customer. Must be unique for your organization. It is used for idempotency: retrying a batch with the same id never creates a second batch, and answers 409 with the stored batch.

source_namestring

A free-form label for the origin of the batch (e.g. the name of your process). Returned when you read the batch.

Example request

{
  "validation_requests": [
    {
      "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"
      }
    }
  ]
}

Response

Validation batch correctly received. Returns the batch with status "pending" and each request's id and status. The results will be sent to the batch webhook configured for the Validator service.

idstring required

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

source_type'api' required

Always api for batches created through this endpoint.

source_namestring required

The source_name you sent, or api if you did not send one.

status'pending' required

Always pending for a just-accepted batch.

timeout_atstring date-time required

When the batch times out. 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 was closed. Always null here.

inserted_atstring date-time required
updated_atstring date-time required

Changes

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