Request a validation

​

Requests a validation to be performed by Shinkansen Validator. The validation will be performed asynchronously and the result will be sent to the webhook configured for the Validator service

Body

application/json

Validation request

  • account_details
    Type: object
    required

    Validation Account Details

    Properties: 7
  • id
    Type: stringFormat: uuid
    required

    The id of the validation request. 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.

  • perform_account_access_check
    Type: boolean

    When set to true, Shinkansen will transfer a random amount (between $1 and $99 CLP) instead of the fixed $1. After the transfer is confirmed, the transferred amount (access_check_amount) will be included in the response. The customer can then ask the end user how much they received to verify account ownership. Only available for CLP currency. Requires the validator_variable_amount_cl product to be enabled.

Responses

  • application/json
  • 400

    Validation request invalid or malformed (e.g: unable to parse, missing or invalid fields).

  • 403

    Forbidden (e.g: wrong API Key)

  • application/json

Callbacks

Request Example for post/validation/requests
curl https://api.validator.shinkansen.finance/v1/validation/requests \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Shinkansen-Validator-Api-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "id": "3c11df48-dfab-41eb-a3c1-b9f90a0da063",
  "account_details": {
    "name": "Romulo Gallegos",
    "identification": {
      "id_schema": "CLID",
      "id": "11111111-1"
    },
    "financial_institution": {
      "fin_id_schema": "SHINKANSEN",
      "fin_id": "SCOTIABANK_CL"
    },
    "account": "1513523451",
    "account_type": "current_account",
    "currency": "CLP",
    "email": "romulo.gallegos@shinkasen.finance"
  }
}'
🇨🇱 Pending validation
{
  "id": "6f44gh71-ghde-74he-d6f4-e2h23d3gd396",
  "inserted_at": "2022-04-08T18:25:45-04:00",
  "updated_at": "2022-04-08T18:25:45-04:00",
  "status": "pending",
  "account_details": {
    "name": "Romulo Gallegos",
    "identification": {
      "id_schema": "CLID",
      "id": "11111111-1"
    },
    "financial_institution": {
      "fin_id_schema": "SHINKANSEN",
      "fin_id": "SCOTIABANK_CL"
    },
    "account": "1513523451",
    "account_type": "current_account",
    "currency": "CLP",
    "email": "romulo.gallegos@shinkasen.finance"
  }
}

Validation request correctly received. Returns a validation request object, with status "pending". The result will be sent to the webhook configured for the Validator service.

Previous
Account Validation
Next
Returns the validation request including status and (if not pending) response