Receives the results of a validation batch
Webhook for receiving the results of a validation batch created through POST /v1/validation/batches. It is called once per batch, when none of its validation requests is pending, with every request in its final state.
It is configured separately from the single validation webhook (in the Shinkansen Dashboard, as the validator batch webhook), and it is signed the same way: the Shinkansen-Validator-Signature header carries the HMAC SHA-256 of the raw body, in hexadecimal, computed with your Validator shared secret.
Answer 2xx once the results are stored. Any other answer, or no answer, is retried, up to 5 attempts with increasing delays. 409 is treated as already received. header.shinkansen_message_id is the same on every retry of a batch, so you can use it to discard repeated deliveries.
If no batch webhook is configured, nothing is sent: read the results with GET /v1/validation/batches/{id}.
Request
- Base URLhttps://example.customer.url/validations
- URLhttps://example.customer.url/validations/validations/batches
- AuthAPI key in header Shinkansen-Validator-Signature
Request body
Example request
{
"document": {
"header": {
"sender": {
"fin_id_schema": "SHINKANSEN",
"fin_id": "SHINKANSEN"
},
"receiver": {
"fin_id_schema": "SHINKANSEN"
}
},
"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"
}
}
]
}
}Response
Results correctly received.
Changes
No recorded changes to this operation across all 1 revision of this API.