latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Person identifications

(Sanbox only) Simulate outcome for BankPlusIdent

This endpoint allows you to easily test different scenarios while integrating BankPlusIdent, such as pre_successful, failed, aborted, or canceled statuses. It requires the identification to be in a pending/aborted/canceled status to simulate the desired scenario.

patch/v1/persons/{person_id}/identifications/{id}/simulate_outcome

Path parameters

person_idstring required

The unique ID of the person resource created for a customer.

Example:dc1a6812a14f6cc338cd084208535bcdcper
idstring required

The unique ID of the identification resource created for a customer.

Example:6dc54352d6793a892e0702850d07b831cidt

Request body

scenario'SUCCESSFUL_PRE_IDENT' | 'FAILED_PRE_IDENT' | 'ABORTED_PRE_IDENT' | 'CANCELED_PRE_IDENT' | 'SUCCESSFUL_ACCOUNT_OPENING' | 'FAILED_ACCOUNT_OPENING' | 'SUCCESSFUL_REFERENCE_TRANSFER' | 'FAILED_REFERENCE_TRANSFER_NAME_CHECK' required

The scenario to simulate the outcome.

Example request

{
  "scenario": "SUCCESSFUL_PRE_IDENT"
}

Response

Successful result of the operation