Internal

Creates a validation batch for a given customer

Used internally by Shinkansen (e.g, for the Shinkansen Dashboard).

post/internal/customers/{customer_shinkansen_fin_id}/validation_batches

Request

Base URL
https://api.validator.shinkansen.finance/v1
URL
https://api.validator.shinkansen.finance/v1/internal/customers/{customer_shinkansen_fin_id}/validation_batches
Auth
- API key in header Shinkansen-Validator-Api-Key
- or API key in header Shinkansen-Validator-Signature

Request body

idstring uuid required

The id of the validation batch. Set by customer. Must be unique. It is used for idempotency: You can retry the same request with the same id and Shinkansen Validator will process it only once.

source_type'file' | 'other' required

The type of the source of the validation batch. Set by customer. Can be:

file if the validation batch was created via a CSV/Excel upload
other if the validation batch was created from any other source

source_namestring required

The name of the source of the validation batch. If source_type is file then this is the name of the file that was uploaded. Set by customer.

Example request

{
  "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"
      }
    },
    {
      "id": "41b3f6a0-0b0e-4b0e-9b0e-0b0e0b0e0b0e",
      "account_details": {
        "name": "Federico Garcia Lorca",
        "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": "federico@gmail.com"
      }
    }
  ]
}

Response

Validation batch correctly received. Returns a validation batch object, with status "pending". Currently NO webhook will be invoked for validations triggered in batches.

idstring uuid required

The id of the validation batch. Set by customer. Must be unique. It is used for idempotency: You can retry the same request with the same id and Shinkansen Validator will process it only once.

source_type'file' | 'other' required

The type of the source of the validation batch. Set by customer. Can be:

file if the validation batch was created via a CSV/Excel upload
other if the validation batch was created from any other source

source_namestring required

The name of the source of the validation batch. If source_type is file then this is the name of the file that was uploaded. Set by customer.

inserted_atstring date-time required

The timestamp when the validation batch was created. Set by Shinkansen Validator.

updated_atstring date-time required

The timestamp when the validation batch was last updated. Set by Shinkansen Validator.

status'pending' | 'performed' required

The status of the batch as a whole. It can be:

pending if at least one of the validations in the batch is pending (or is being retried due to errors)
performed if all of the validations have been completed (even if some of them failed after retrying a few times)

Example response

{
  "inserted_at": "2021-01-01T00:00:00.000Z",
  "updated_at": "2021-01-01T00:00:00.000Z",
  "status": "pending"
}

Changes

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