Identity Verification testing

Last updated: October 16, 2024

You can test different Identity Verification scenarios using the examples on this page.

Set up webhooks to test real-time notifications for each event in this scenario:

Call the Create an applicant endpoint, setting the external_applicant_id value to eaplt_10000000000000000000000000.

post

https://api.sandbox.checkout.com/applicants


1{
2  "external_applicant_id": "eaplt_10000000000000000000000000",
3  "email": "[email protected]"
4}


1{
2  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "external_applicant_id": "eaplt_10000000000000000000000000",
6  "email": "[email protected]",
7  "_links": {
8    "self": {
9      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
10    }
11  }
12}

Call the Create an identity verification endpoint, setting the id you received in the step 2 response as the applicant_id value.

For example, in this case the id returned is aplt_tkoi5db4hryu5cei5vwoabr7we.

post

https://identity-verification.sandbox.checkout.com/identity-verifications


1{
2  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
3  "declared_data": {
4    "name": "Toby Arden",
5      "birth_date": "1984-10-02"
6  },
7  "redirect_url": "https://example.com?query-param=hello"
8}


1{
2    "id": "idv_tkoi5db4hryu5cei5vwoabr7we",
3    "created_on": "2023-07-21T17:32:28Z",
4    "modified_on": "2023-07-21T17:40:32Z",
5    "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
6    "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
7    "status": "pending",
8    "response_codes": [],
9    "declared_data": {
10      "name": "Toby Arden",
11      "birth_date": "1984-10-02"
12    },
13    "documents": [],
14    "redirect_url": "https://example.com?query-param=hello",
15    "_links": {
16      "self": {
17        "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
18      },
19      "verification_url": {
20        "href": "https://idv.checkout.com/4hryu5cei5/"
21      }
22  }
23}

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr7.

post

https://api.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2   "phone_number": {
3      "country_code": "+1",
4      "number": "5555700102"
5   },
6   "redirect_url": "https://example.com?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "5555700102"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks are triggered. The identity_verification_checks_completed webhook returns the response code 10000.

Call the Retrieve an identity verification endpoint, providing the verification id value from the step 3 response as the {identity_verification_id} path parameter.

get

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}


1{
2  "id": "idv_tkoi5db4hryu5cei5vwoabr7we",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
6  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
7  "status": "approved",
8  "response_codes": [
9    {
10      "code": 10000,
11      "summary": "approved"
12    }
13  ],
14  "verified_identity": {
15    "full_name": "Toby Arden",
16    "birth_date": "1984-10-02"
17  },
18  "declared_data": {
19    "name": "Toby Arden",
20    "birth_date": "1984-10-02"
21  },
22  "documents": [
23    {
24      "full_name": "Toby Arden",
25      "birth_date": "1984-10-02",
26      "document_type": "ID",
27      "document_issuing_country": "US",
28      "front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
29    }
30  ],
31  "face": {
32    "image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
33  },
34  "phone_number": {
35    "country_code": "+1",
36    "number": "5555550102"
37  },
38  "redirect_url": "https://example.com?query-param=hello",
39  "_links": {
40    "self": {
41      "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
42    },
43    "verification_url": {
44      "href": "https://idv.checkout.com/4hryu5cei5/"
45    }
46  }
47}

Set up webhooks to test real-time notifications for each event in this scenario.

Webhooks for the first attempt:

Webhooks for the final result:

Call the Create an applicant endpoint, setting the external_applicant_id value to eaplt_61XXXA10000000000000000000. Replace 61XXX with a response code starting with 61 that you want to test.

For example, to test with response code 61401, set the external_application_id to eaplt_61401A10000000000000000000.

post

https://api.sandbox.checkout.com/applicants


1{
2  "external_applicant_id": "eaplt_61401A1000000000000000000",
3  "email": "[email protected]"
4}


1{
2  "id": "aplt_tkoi5db4hryu5cei5vwoabr8hg",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "external_applicant_id": "eaplt_61401A1000000000000000000",
6  "email": "[email protected]",
7  "_links": {
8    "self": {
9      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr8hg"
10    }
11  }
12}

Call the Create an identity verification endpoint, setting the id you received in the step 2 response as the applicant_id value.

For example, in this case the id returned is aplt_tkoi5db4hryu5cei5vwoabr8hg.

post

https://identity-verification.sandbox.checkout.com/identity-verifications


1{
2  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr8hg",
3  "declared_data": {
4    "name": "Jia Tsang",
5    "birth_date": "1984-10-02"
6  },
7  "redirect_url": "https://example.com?query-param=hello"
8}


1{
2    "id": "idv_tkoi5db4hryu5cei5vwoabr8hg",
3    "created_on": "2023-07-21T17:32:28Z",
4    "modified_on": "2023-07-21T17:40:32Z",
5    "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr8hg",
6    "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr8hg",
7    "status": "pending",
8    "response_codes": [],
9    "declared_data": {
10      "name": "Jia Tsang",
11      "birth_date": "1984-10-02"
12    },
13    "documents": [],
14    "redirect_url": "https://example.com?query-param=hello",
15    "_links": {
16      "self": {
17        "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr8hg"
18      },
19      "verification_url": {
20        "href": "https://idv.checkout.com/4hryu5cei5/"
21      }
22    }
23}

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr8hg.

post

https://api.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2   "phone_number": {
3      "country_code": "+1",
4      "number": "5555500102"
5   },
6   "redirect_url": "https://example.com?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "5555500102"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks for the first attempt are triggered. The identity_verification_capture_aborted webhook returns the response code starting with 61 that you provided for external_applicant_id.

When the identity_verification_capture_aborted webhook returns the retry_required status, create another attempt.

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr8hg.

post

https://api.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2   "phone_number": {
3      "country_code": "+1",
4      "number": "5555500102"
5   },
6   "redirect_url": "https://example.com?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "5555500102"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks for the final result are triggered. The identity_verification_checks_completed webhook returns the response code 10000.

Call the Retrieve an identity verification endpoint, providing the id value from the step 3 response as the {identity_verification_id} path parameter.

get

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}


1{
2  "id": "idv_tkoi5db4hryu5cei5vwoabr8hg",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr8hg",
6  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr8hg",
7  "status": "approved",
8  "response_codes": [
9    {
10      "code": 10000,
11      "summary": "approved"
12    }
13  ],
14  "verified_identity": {
15    "full_name": "Jia Tsang",
16    "birth_date": "1984-10-02"
17  },
18  "declared_data": {
19    "name": "Jia Tsang",
20    "birth_date": "1984-10-02"
21  },
22  "documents": [
23    {
24      "full_name": "Jia Tsang",
25      "birth_date": "1984-10-02",
26      "document_type": "ID",
27      "document_issuing_country": "US",
28      "front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
29    }
30  ],
31  "face": {
32    "image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
33  },
34  "phone_number": {
35    "country_code": "+1",
36    "number": "5555550102"
37  },
38  "redirect_url": "https://example.com?query-param=hello",
39  "_links": {
40    "self": {
41      "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr8hg"
42    },
43    "verification_url": {
44      "href": "https://idv.checkout.com/4hryu5cei5/"
45    }
46  }
47}

Set up webhooks to test real-time notifications for each event in this scenario.

Webhooks for the first attempt:

Webhooks for the final result:

Call the Create an applicant endpoint, setting the external_applicant_id value to eaplt_61XXXI10000000000000000000. Replace 61XXX with a response code starting with 61 that you want to test.

For example, if you want to test with response code 61310, set the external_application_id to eaplt_61310I10000000000000000000.

post

https://api.sandbox.checkout.com/applicants


1{
2  "external_applicant_id": "eaplt_61310I1000000000000000000",
3  "email": "[email protected]"
4}


1{
2  "id": "aplt_tkoi5db4hryu5cei5vwoabr7wf",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "external_applicant_id": "eaplt_61310I10000000000000000000",
6  "email": "[email protected]",
7  "_links": {
8    "self": {
9      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr7wf"
10    }
11  }
12}

Call the Create an identity verification endpoint, setting the id you received in the step 2 response as the applicant_id value.

For example, in this case the id returned is aplt_tkoi5db4hryu5cei5vwoabr7wf.

post

https://identity-verification.sandbox.checkout.com/identity-verifications


1{
2  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7wf",
3  "declared_data": {
4    "name": "Jia Tsang",
5    "birth_date": "1995-10-02"
6  },
7  "redirect_url": "https://example.com?query-param=hello"
8}


1{
2    "id": "idv_tkoi5db4hryu5cei5vwoabr7wf",
3    "created_on": "2023-07-21T17:32:28Z",
4    "modified_on": "2023-07-21T17:40:32Z",
5    "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7wf",
6    "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7wf",
7    "status": "pending",
8    "response_codes": [],
9    "declared_data": {
10      "name": "Jia Tsang",
11      "birth_date": "1995-10-02"
12    },
13    "documents": [],
14    "redirect_url": "https://example.com?query-param=hello",
15    "_links": {
16      "self": {
17        "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7wf"
18      },
19      "verification_url": {
20        "href": "https://idv.checkout.com/4hryu5cei5/"
21      }
22    }
23}

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr7wf.

post

https://api.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2   "phone_number": {
3      "country_code": "+1",
4      "number": "5555500102"
5   },
6   "redirect_url": "https://example.com?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "5555500102"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks for the first attempt are triggered. The identity_verification_checks_inconclusive webhook returns the response code starting with 61 that you provided for external_applicant_id.

When the identity_verification_checks_inconclusive webhook returns the retry_required status, create another attempt.

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr7wf.

post

https://api.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2   "phone_number": {
3      "country_code": "+1",
4      "number": "5555500102"
5   },
6   "redirect_url": "https://example.com?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "5555500102"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks for the final result are triggered. The identity_verification_checks_inconclusive webhook returns the response code starting with 61 that you provided for external_applicant_id.

Call the Retrieve an identity verification endpoint, providing the verification id value from the step 3 response as the {identity_verification_id} path parameter.

get

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}


1{
2  "id": "idv_tkoi5db4hryu5cei5vwoabr7wf",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7wf",
6  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7wf",
7  "status": "approved",
8  "response_codes": [
9    {
10      "code": 10000,
11      "summary": "approved"
12    }
13  ],
14  "verified_identity": {
15    "full_name": "Jia Tsang",
16    "birth_date": "1995-10-02"
17  },
18  "declared_data": {
19    "name": "Jia Tsang",
20    "birth_date": "1995-10-02"
21  },
22  "documents": [
23    {
24      "full_name": "Jia Tsang",
25      "birth_date": "1995-10-02",
26      "document_type": "ID",
27      "document_issuing_country": "US",
28      "front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
29    }
30  ],
31  "face": {
32    "image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
33  },
34  "phone_number": {
35    "country_code": "+1",
36    "number": "5555550102"
37  },
38  "redirect_url": "https://example.com?query-param=hello",
39  "_links": {
40    "self": {
41      "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
42    },
43    "verification_url": {
44      "href": "https://idv.checkout.com/4hryu5cei5/"
45    }
46  }
47}

Set up webhooks to test real-time notifications for each event in this scenario:

Call the Create an applicant endpoint, setting the external_applicant_id value to eaplt_62XXX000000000000000000000. Replace 62XXX with a response code starting with 62 that you want to test.

For example, if you want to test with 62201, then set the value to eaplt_62201000000000000000000000

post

https://api.sandbox.checkout.com/applicants


1{
2  "external_applicant_id": "eaplt_62201000000000000000000000",
3  "email": "[email protected]"
4}


1{
2  "id": "aplt_tkoi5db4hryu5cei5vwoabr9fr",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "external_applicant_id": "eaplt_62201000000000000000000000",
6  "email": "[email protected]",
7  "_links": {
8    "self": {
9      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr9fr"
10    }
11  }
12}

Call the Create an identity verification endpoint, setting the id you received in the step 2 response as the applicant_id value. For example, in this case the id returned is aplt_tkoi5db4hryu5cei5vwoabr9fr.

post

https://identity-verification.sandbox.checkout.com/identity-verifications


1{
2  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr9fr",
3  "declared_data": {
4    "name": "Hannah Bret",
5    "birth_date": "1999-12-02"
6},
7  "redirect_url": "https://example.com?query-param=hello"
8}


1{
2    "id": "idv_tkoi5db4hryu5cei5vwoabr9fr",
3    "created_on": "2017-07-21T17:32:28Z",
4    "modified_on": "2017-07-21T17:40:32Z",
5    "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr9fr",
6    "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr9fr",
7    "status": "pending",
8    "response_codes": [],
9    "declared_data": {
10      "name": "Hannah Bret",
11      "birth_date": "1999-12-02"
12    },
13    "documents": [],
14    "redirect_url": "https://example.com?query-param=hello",
15    "_links": {
16      "self": {
17        "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr9fr"
18      },
19      "verification_url": {
20        "href": "https://idv.checkout.com/4hryu5cei5/"
21      }
22  }
23}

Call the Create an attempt endpoint, setting the id you received in the step 3 response as the {identity_verification_id} path parameter value.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr9fr.

post

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2  "phone_number": {
3    "country_code": "+1",
4    "number": "2068133616"
5  },
6  "redirect_url": "https://myweb.site?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2017-07-21T17:32:28Z",
4  "modified_on": "2017-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "2068133616"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks are triggered. The identity_verification_checks_completed webhook returns the response code starting with 62 that you provided for external_applicant_id.

Call the Retrieve an identity verification endpoint, providing the verification id value from the step 3 response as the {identity_verification_id} path parameter.

get

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}


1{
2  "id": "idv_tkoi5db4hryu5cei5vwoabr9fr",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr9fr",
6  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr9fr",
7  "status": "declined",
8  "response_codes": [
9    {
10      "code": 62201,
11      "summary": "document_photocopy"
12    }
13  ],
14  "verified_identity": {
15    "full_name": "Hannah Bret",
16    "birth_date": "1999-12-02"
17  },
18  "declared_data": {
19    "name": "Hannah Bret",
20    "birth_date": "1999-12-02"
21  },
22  "documents": [
23    {
24      "full_name": "Hannah Bret",
25      "birth_date": "1999-12-02",
26      "document_type": "ID",
27      "document_issuing_country": "US",
28      "front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
29    }
30  ],
31  "face": {
32    "image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
33  },
34  "phone_number": {
35    "country_code": "+1",
36    "number": "5555550102"
37  },
38  "redirect_url": "https://example.com?query-param=hello",
39  "_links": {
40    "self": {
41      "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr9fr"
42    },
43    "verification_url": {
44      "href": "https://idv.checkout.com/4hryu5cei5/"
45    }
46  }
47}

Set up webhooks to test real-time notifications for each event in this scenario.

Webhooks for the first attempt:

Webhooks for the final result:

Call the Create an applicant endpoint, setting the external_applicant_id value to eaplt_61XXXA62XXX000000000000000. Replace:

61XXX with a response code starting with 61 for the end of the first attempt
62XXX with a response code starting with 62 for the final result

For example, to test with response codes 61203 and 62103, then set the value to eaplt_61203A62103000000000000000.

post

https://api.sandbox.checkout.com/applicants


1{
2  "external_applicant_id": "eaplt_61203A6210300000000000000",
3  "email": "[email protected]"
4}


1{
2  "id": "aplt_tkoi5db4hryu5cei5vwoabr1ab",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "external_applicant_id": "eaplt_61203A6210300000000000000",
6  "email": "[email protected]",
7  "_links": {
8    "self": {
9      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr1ab"
10    }
11  }
12}

Call the Create an identity verification endpoint, setting the id you received in the step 2 response as the applicant_id value.

For example, in this case the id returned is aplt_tkoi5db4hryu5cei5vwoabr1ab.

post

https://identity-verification.sandbox.checkout.com/identity-verifications


1{
2  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr1ab",
3  "declared_data": {
4    "name": "Ali Farid",
5    "birth_date": "1990-12-20"
6},
7  "redirect_url": "https://example.com?query-param=hello"
8}


1{
2    "id": "idv_tkoi5db4hryu5cei5vwoabr1ab",
3    "created_on": "2023-07-21T17:32:28Z",
4    "modified_on": "2023-07-21T17:40:32Z",
5    "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr1ab",
6    "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr1ab",
7    "status": "pending",
8    "response_codes": [],
9    "declared_data": {
10      "name": "Ali Farid",
11      "birth_date": "1990-12-20"
12    },
13    "documents": [],
14    "redirect_url": "https://example.com?query-param=hello",
15    "_links": {
16      "self": {
17        "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr1ab"
18      },
19      "verification_url": {
20        "href": "https://idv.checkout.com/4hryu5cei5/"
21      }
22    }
23}

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr1ab.

post

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2  "phone_number": {
3    "country_code": "+1",
4    "number": "2068133616"
5  },
6  "redirect_url": "https://myweb.site?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2017-07-21T17:32:28Z",
4  "modified_on": "2017-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "2068133616"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

When the identity_verification_capture_aborted webhook returns the retry_required status, create another attempt.

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr1ab.

post

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2  "phone_number": {
3    "country_code": "+1",
4    "number": "2068133616"
5  },
6  "redirect_url": "https://myweb.site?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2017-07-21T17:32:28Z",
4  "modified_on": "2017-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "2068133616"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

At this stage, the webhooks for the final result are triggered. The identity_verification_checks_completed webhook returns the response code starting with 62 that you provided for external_applicant_id.

Call the Retrieve an identity verification endpoint, providing the verification id value from the step 3 response as the {identity_verification_id} path parameter.

get

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}


1{
2  "id": "idv_tkoi5db4hryu5cei5vwoabr1ab",
3  "created_on": "2017-07-21T17:32:28Z",
4  "modified_on": "2017-07-21T17:40:32Z",
5  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr1ab",
6  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr1ab",
7  "status": "declined",
8  "response_codes": [
9    {
10      "code": 62103,
11      "summary": "document_damaged"
12    }
13  ],
14  "verified_identity": {
15    "full_name": "Ali Farid",
16    "birth_date": "1990-12-20"
17  },
18  "declared_data": {
19    "name": "Ali Farid",
20    "birth_date": "1990-12-20"
21  },
22  "documents": [
23    {
24      "full_name": "Ali Farid",
25      "birth_date": "1990-12-20",
26      "document_type": "ID",
27      "document_issuing_country": "US",
28      "front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
29    }
30  ],
31  "face": {
32    "image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
33  },
34  "phone_number": {
35    "country_code": "+1",
36    "number": "2068133616"
37  },
38  "redirect_url": "https://example.com?query-param=hello",
39  "_links": {
40    "self": {
41      "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
42    },
43    "verification_url": {
44      "href": "https://idv.checkout.com/4hryu5cei5/"
45    }
46  }
47}

Set up webhooks to test real-time notifications for each event in this scenario.

Webhooks for the first attempt:

Webhooks for the final result:

Call the Create an applicant endpoint, setting the external_applicant_id value to eaplt_61XXXI62XXX000000000000000. Replace:

61XXX with a response code starting with 61 for the end of the first attempt
62XXX with a response code starting with 62 for the final result

For example, to test with response codes 61203 and 62403, set the value to eaplt_61411I62403000000000000000.

post

`https://api.sandbox.checkout.com/applicants`


1{
2  "external_applicant_id": "eaplt_61203I6240300000000000000",
3  "email": "[email protected]"
4}


1{
2  "id": "aplt_tkoi5db4hryu5cei5vwoabr6ft",
3  "created_on": "2023-07-21T17:32:28Z",
4  "modified_on": "2023-07-21T17:40:32Z",
5  "external_applicant_id": "eaplt_61203I6240300000000000000",
6  "email": "[email protected]",
7  "_links": {
8    "self": {
9      "href": "https://identity-verification.sandbox.checkout.com/applicants/aplt_tkoi5db4hryu5cei5vwoabr6ft"
10    }
11  }
12}

Call the Create an identity verification endpoint, setting the id you received in the step 2 response as the applicant_id value.

For example, in this case the id returned is aplt_tkoi5db4hryu5cei5vwoabr6ft.

post

https://identity-verification.sandbox.checkout.com/identity-verifications


1{
2  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr6ft",
3  "declared_data": {
4    "name": "Toby Arden",
5    "birth_date": "1994-09-26"
6},
7  "redirect_url": "https://example.com?query-param=hello"
8}


1{
2    "id": "idv_tkoi5db4hryu5cei5vwoabr6ft",
3    "created_on": "2023-07-21T17:32:28Z",
4    "modified_on": "2023-07-21T17:40:32Z",
5    "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr6ft",
6    "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr6ft",
7    "status": "pending",
8    "response_codes": [],
9    "declared_data": {
10      "name": "Toby Arden",
11      "birth_date": "1994-09-26"
12    },
13    "documents": [],
14    "redirect_url": "https://example.com?query-param=hello",
15    "_links": {
16      "self": {
17        "href": "https://identity-verification.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr6ft"
18      },
19      "verification_url": {
20        "href": "https://idv.checkout.com/4hryu5cei5/"
21      }
22    }
23}

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr6ft.

post

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2  "phone_number": {
3    "country_code": "+1",
4    "number": "2068133616"
5  },
6  "redirect_url": "https://myweb.site?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2017-07-21T17:32:28Z",
4  "modified_on": "2017-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "2068133616"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

When the identity_verification_checks_inconclusive webhook returns retry_required status, create another attempt.

Call the Create an attempt endpoint, setting the verification id value from the step 3 response as the {identity_verification_id} path parameter.

For example, in this case the id returned is idv_tkoi5db4hryu5cei5vwoabr6ft.

post

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}/attempts


1{
2  "phone_number": {
3    "country_code": "+1",
4    "number": "2068133616"
5  },
6  "redirect_url": "https://myweb.site?query-param=hello"
7}


1{
2  "id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",
3  "created_on": "2017-07-21T17:32:28Z",
4  "modified_on": "2017-07-21T17:40:32Z",
5  "phone_number": {
6    "country_code": "+1",
7    "number": "2068133616"
8  },
9  "redirect_url": "https://myweb.site?query-param=hello",
10  "status": "pending_redirection",
11  "response_codes": [],
12  "_links": {
13    "verification_url": {
14      "href": "https://idv.checkout.com/4hryu5cei5/"
15    },
16     "self": {
17            "href": "https://identity-verification.sandbox.checkout.com/identity-verifications/idv_01j58p8rw1hvterhqt66xn6js2/attempts/iatp_tkoi5db4hryu5cei5vwoabrPoQ"
18        }
19  }
20}

Call the Retrieve an identity verification endpoint, providing the verification id value from the step 2 response as the {identity_verification_id} path parameter.

get

https://identity-verification.sandbox.checkout.com/identity-verifications/{identity_verification_id}


1{
2  "id": "idv_tkoi5db4hryu5cei5vwoabr6ft",
3  "created_on": "2023-10-06T17:32:28Z",
4  "modified_on": "2023-10-06T17:40:32Z",
5  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr6ft",
6  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr6ft",
7  "status": "declined",
8  "response_codes": [
9    {
10      "code": 62403,
11      "summary": "consent_unclear"
12    }
13  ],
14  "verified_identity": {
15    "full_name": "Toby Arden",
16    "birth_date": "1994-09-26"
17  },
18  "declared_data": {
19    "name": "Toby Arden",
20    "birth_date": "1994-09-26"
21  },
22  "documents": [
23    {
24      "full_name": "Toby Arden",
25      "birth_date": "1994-09-26",
26      "document_type": "ID",
27      "document_issuing_country": "US",
28      "front_image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
29    }
30  ],
31  "face": {
32    "image_signed_url": "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20231006T174223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4"
33  },
34  "_links": {
35    "self": {
36      "href": "https://identity-verifications.sandbox.checkout.com/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr6ft"
37    },
38    "verification_url": {
39      "href": "https://idv.checkout.com/4hryu5cei5/"
40    }
41  }
42}

Successful verification

Step 1: Configure webhooks

Step 2: Create an applicant

Request example

Response example

Step 3: Create an identity verification

Request example

Response example

Step 4: Create an attempt

Request example

Response example

(Optional) Step 5: Retrieve an identity verification

Response example

Successful verification on retry after capture aborted

Step 1: Configure webhooks

Step 2: Create an applicant

Request example

Response example

Step 3: Create an identity verification

Request example

Response example

Step 4: Create an attempt

Request example

Response example

Step 5: Create another attempt

Request example

Response example

(Optional) Step 6: Retrieve an identity verification

Response example

Successful verification on retry after checks inconclusive

Step 1: Configure webhooks

Step 2: Create an applicant

Request example

Response example

Step 3: Create an identity verification

Request example

Response example

Step 4: Create an attempt

Request example

Response example

Step 5: Create another attempt

Request example

Response example

(Optional) Step 6: Retrieve an identity verification

Response example

Declined verification

Step 1: Configure webhooks

Step 2: Create an applicant

Request example

Response example

Step 3: Create an identity verification

Request example

Response example

Step 4: Create an attempt

Request example

Response example

(Optional) Step 5: Retrieve an identity verification

Response example

Declined verification on retry after capture aborted

Step 1: Configure webhooks

Step 2: Create an applicant

Request example

Response example

Step 3: Create an identity verification

Request example

Response example

Step 4: Create an attempt

Request example

Response example

Step 5: Create another attempt

Request example

Response example

(Optional) Step 6: Retrieve an identity verification

Response example

Declined verification on retry after checks inconclusive

Step 1: Configure webhooks

Step 2: Create an applicant

Request example

Response example

Step 3: Create an identity verification