Home
HomeGuidesRecipesAPI ReferenceGraphQLChangelogDiscussionsv2023.08
HomeLog In
API Reference
These docs are for v2023.08. Click to read the latest docs for v2023.12.

Update the Onfido SDK Outcome

patch
https://broker-api.sandbox.alpaca.markets/v1/accounts//onfido/sdk

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.

Path Params
string
required
Body Params
string
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

string

Any additional information related to the outcome

string
required

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

Responses
200

OK

404

Account Not Foundā€‹

422

Invalid input value for outcome.

Updated over 2 years ago

Language
Credentials
Basic
base64
:
URL
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here!

Updated over 2 years ago

Ā©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible