Questions? Feedback? powered by Olark live chat software

Integration Helper Verification

Note

This endpoint is not for use in production. It is available only in the sandbox environment. We have included it to help you test your integration. It allows you to perform the back office functionality described on this page.

Making a personal submission

A verification submission can be made for a customer quite simply - currently the endpoint will submit a set of predetermined data.

In order to submit a personal (tier 2) verification, the following endpoint call can be made:

1
2
3
4
5
6
7
8
9
% curl "https://integrationhelper.escrow-sandbox.com/v1/customer/991817/verification" \
    -X POST \
    -u "email-address:your-password" \
    -H "Content-Type: application/json" \
    -d '
{
    "personal": true,
    "company": false
}'

Example Response

1
2
3
{
    "submission_id": 60
}

Accepting/rejecting a submission

Using the submission id returned from the previous endpoint, a verification submission can be approved or rejected accordingly.

Approving a submission:

1
2
3
4
5
6
7
8
% curl "https://integrationhelper.escrow-sandbox.com/v1/customer/991817/verification/60" \
    -X PATCH \
    -u "email-address:your-password" \
    -H "Content-Type: application/json" \
    -d '
{
    "action": "approve"
}'

Rejecting a submission:

1
2
3
4
5
6
7
8
% curl "https://integrationhelper.escrow-sandbox.com/v1/customer/991817/verification/60" \
    -X PATCH \
    -u "email-address:your-password" \
    -H "Content-Type: application/json" \
    -d '
{
    "action": "reject"
}'