Callback: Add/Update

Subscribe to callbacks for onboarding submission events. Callbacks will be sent to the provided callbackUrl when the specified events occur.

Event Triggers:

  • SUBMISSION_SUBMITTED: Triggered when an onboarding submission is successfully submitted (status: SUBMITTED)
  • SUBMISSION_IN_APPROVAL_PLIANT: Triggered when risk/compliance PASS was received and Pliant manual steps are ongoing (status: SUBMITTED)
  • SUBMISSION_IN_APPROVAL_BANKINGPARTNER: Triggered when the case is submitted to the bank partner (status: SUBMITTED)
  • SUBMISSION_APPROVED: Triggered when the bank submission is approved (status: APPROVED)
  • SUBMISSION_REJECTED: Triggered when the submission is rejected (status: REJECTED)
  • SUBMISSION_NEEDS_MORE_INFO: Currently not sent
  • SUBMISSION_WITHDRAWN: Triggered when an onboarding submission is terminated (status: WITHDRAWN)

For information about callback structure, headers, authentication, and verification, see the Callbacks documentation.

Body Params
uri
required

The URL to send the callback to. Must be a valid and reachable URL. Only HTTPS URLs are supported.

eventTypes
array of strings
required
length ≥ 1

The event types to subscribe to.

eventTypes*
Responses

Callbacks
Language
Credentials
Bearer
JWT
URL
Response
Choose an example:
application/json