SHshinkansen
Account Validation

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

post/validation/requests

Request

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

Request body

idstring 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_checkboolean

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.

Example request

{
  "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"
  }
}

Response

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.

idstring 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_checkboolean

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.

inserted_atstring date-time required

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

updated_atstring date-time required

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

status'pending' | 'performed' | 'error' required

The validation status. Set by Shinkansen Validator. One of:

  • pending: The validation is still pending. A response hasn't been generated yet and will not be present
  • performed: The validation was performed. Therefore the validation response will be present and its return_code is valid_account_details, invalid_account_details or, 🇲🇽 only, no_id_on_bank.
  • error: The validation couldn't be performed due to an error. Therefore the validation response code is unable_to_validate. You can retry by posting a new validation request with a different id and same content.
access_check_amountnumber

The random amount (in CLP) that was transferred to the account for ownership verification. Only present when perform_account_access_check is true and status is performed. Not included when status is pending or error. The customer should ask the end user how much they received and compare it with this value.

Example response

{
  "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.