ALalpacahq
KYC

Update the Onfido SDK Outcome

This request allows you to send Alpaca the result of the Onfido SDK flow in your app. A notification of a successful outcome is required for Alpaca to continue the KYC process.

patch/v1/accounts/{account_id}/onfido/sdk

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/accounts/{account_id}/onfido/sdk
  • Auth
    HTTP basic

Request body

outcomestring required

"NOT_STARTED" The user has not started the SDK flow yet. outcome is set to this default value upon token generation "USER_EXITED" The user exited the SDK flow "SDK_ERROR" An error occurred in the SDK flow "USER_COMPLETED" The user completed the SDK flow

reasonstring

Any additional information related to the outcome

tokenstring required

The SDK token associated with the SDK flow you are updating the outcome for

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.