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