Receives results from Shinkansen Validator

Webhook for receiving validation responses

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.
- inserted_at
  Type: stringFormat: date-time
  required
  
  The timestamp when the validation request was created. Set by Shinkansen Validator.
- status
  Type: "pending" or "performed" or "error"enum
  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 result_code is either valid_account_details or invalid_account_details.
  
  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.
- updated_at
  Type: stringFormat: date-time
  required
  
  The timestamp when the validation request was last updated. Set by Shinkansen Validator.
- access_check_amount
  Type: number
  
  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.
- 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.
- response
  Type: object
  
  The validation response. Set by Shinkansen Validator. Will only be present if the validation status is not pending.
  
  Properties: 3

Responses

200

Result correctly received.
400

Result invalid (e.g: bad signature) or malformed (e.g: unable to parse)
409

Result already received in a previous invocation for the same request

post/validations

curl https://example.customer.url/validations/validations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Shinkansen-Validator-Signature: YOUR_SECRET_TOKEN' \
  --data '{
  "id": "3c11df48-dfab-41eb-a3c1-b9f90a0da063",
  "inserted_at": "2022-04-08T18:25:45-04:00",
  "updated_at": "2022-04-08T18:25:55-04:00",
  "status": "performed",
  "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"
  },
  "response": {
    "return_code": "valid_account_details",
    "return_message": "OK"
  }
}'

No Body

Result correctly received.

Account Validation

Introduction