curl --request POST \
--url https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/test-helpers/identity-outcome \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mockedResultSpec": {
"status": "approved"
}
}
'Test helpers
Set identity verification outcome
Set the expected outcome for an associated person’s identity verification for testing purposes. This is only available in sandbox and development environments.
POST
/
core
/
kyb
/
associated-persons
/
{personId}
/
test-helpers
/
identity-outcome
curl --request POST \
--url https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/test-helpers/identity-outcome \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"mockedResultSpec": {
"status": "approved"
}
}
'
This endpoint allows you to set a desired outcome for the identity process for an Associated Person.
After setting this value, you must submit the Identity Process using the Update Identity endpoint.
Submitting the IDV process without setting a desired outcome will generate an Approved result.
There is no need to submit real ID documents in Sandbox; any image will
suffice.
Was this page helpful?