Identity Verification testing
Last updated: August 13, 2025
You can test the following Identity Verification scenarios:
- Successful verification
- Successful on retry after capture abandoned
- Successful on retry after checks inconclusive
- Declined verification
- Declined on retry after capture abandoned
- Declined on retry after checks inconclusive
Set up your webhook receiver to test real-time webhooks for every event in each scenario.
Subscribe to the following webhooks:
- identity_verification_created
- identity_verification_opened
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_completed
Call the Create an applicant endpoint, setting the external_applicant_id
field 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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 applicant_id
field to the id
value returned in the Create applicant response.
For example, the id
returned here is aplt_tkoi5db4hryu5cei5vwoabr7we
.
post
https://identity-verification.sandbox.checkout.com/identity-verifications
1{2"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",3"declared_data": {4"name": "Hannah Bret",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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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": "Hannah Bret",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}
The response returns the verification ID, prefixed with idv_
.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
You receive an identity_verification_checks_completed
webhook with the response code 10000
.
Call the Retrieve an identity verification endpoint, and provide the verification ID 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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": "Hannah Bret",16"birth_date": "1984-10-02"17},18"declared_data": {19"name": "Hannah Bret",20"birth_date": "1984-10-02"21},22"documents": [23{24"full_name": "Hannah Bret",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%2F20250327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250327T163228Z&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%2F20250327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250327T163223Z&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}
Subscribe to the following webhooks for the first attempt:
- identity_verification_created
- identity_verification_opened
- identity_verification_started
- identity_verification_capture_aborted
Subscribe to the following webhooks for the final result:
- identity_verification_retry_requested
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_completed
Call the Create an applicant endpoint, setting the external_applicant_id
field to eaplt_61XXXA10000000000000000000
.
Replace 61XXX
with the response code starting with 61
that you want to test.
For example, to test 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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 applicant_id
field to the id
value returned in the Create applicant response.
For example, the id
returned here is aplt_tkoi5db4hryu5cei5vwoabr8hg
.
post
https://identity-verification.sandbox.checkout.com/identity-verifications
1{2"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr8hg",3"declared_data": {4"name": "Hannah Bret",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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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": "Hannah Bret",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}
The response returns the verification ID, prefixed with idv_
.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_capture_aborted
first attempt 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, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_completed
final result webhook returns the response code 10000
.
Optionally, you can retrieve the verification.
Subscribe to the following webhooks for the first attempt:
- identity_verification_created
- identity_verification_opened
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_inconclusive
Subscribe to the following webhooks for the final result:
- identity_verification_retry_requested
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_completed
Call the Create an applicant endpoint, setting the external_applicant_id
field to eaplt_61XXXI10000000000000000000
.
Replace 61XXX
with a response code starting with 61
that you want to test.
For example, if you want to test 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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 applicant_id
field to the id
value returned in the Create applicant response.
For example, the id
returned here is aplt_tkoi5db4hryu5cei5vwoabr7wf
.
post
https://identity-verification.sandbox.checkout.com/identity-verifications
1{2"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7wf",3"declared_data": {4"name": "Hannah Bret",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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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": "Hannah Bret",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}
The response returns the verification ID, prefixed with idv_
.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_inconclusive
first attempt 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, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_inconclusive
final result webhook returns the response code starting with 61
that you provided for external_applicant_id
.
Optionally, you can retrieve the verification.
Subscribe to the following webhooks:
- identity_verification_created
- identity_verification_opened
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_completed
Call the Create an applicant endpoint, setting the external_applicant_id
field to eaplt_62XXX000000000000000000000
.
Replace 62XXX
with a response code starting with 62
that you want to test.
For example, if you want to test 62201
, 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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 applicant_id
field to the id
value returned in the Create applicant response.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The response returns the verification ID, prefixed with idv_
.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_completed
webhook returns the response code starting with 62
that you provided for external_applicant_id
.
Optionally, you can retrieve the verification.
Subscribe to the following webhooks for the first attempt:
- identity_verification_created
- identity_verification_opened
- identity_verification_started
- identity_verification_capture_aborted
Subscribe to the following webhooks for the final result:
- identity_verification_retry_requested
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_completed
Call the Create an applicant endpoint, setting the external_applicant_id
field to eaplt_61XXXA62XXX000000000000000
. Replace:
61XXX
with a response code starting with61
for the first attempt62XXX
with a response code starting with62
for the final result
For example, to test response codes 61203
and 62103
, 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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 applicant_id
field to the id
value returned in the Create applicant response.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The response returns the verification ID, prefixed with idv_
.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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}
The identity_verification_capture_aborted
first attempt webhook returns the response code starting with 61
that you provided for external_applicant_id
.
1{2"id": "iatp_tkoi5db4hryu5cei5vwoabrPoQ",3"created_on": "2025-07-21T17:32:28Z",4"modified_on": "2025-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, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_completed
final result webhook returns the response code starting with 62
that you provided for external_applicant_id
.
Optionally, you can retrieve the verification.
Subscribe to the following webhooks for the first attempt:
- identity_verification_created
- identity_verification_opened
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_inconclusive
Subscribe to the following webhooks for the final result:
- identity_verification_retry_requested
- identity_verification_started
- identity_verification_capture_completed
- identity_verification_checks_completed
Call the Create an applicant endpoint, setting the external_applicant_id
field to eaplt_61XXXI62XXX000000000000000
. Replace:
61XXX
with a response code starting with61
for the first attempt62XXX
with a response code starting with62
for the final result
For example, to test 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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 applicant_id
field to the id
value returned in the Create applicant response.
For example, the id
returned here is aplt_tkoi5db4hryu5cei5vwoabr6ft
.
post
https://identity-verification.sandbox.checkout.com/identity-verifications
1{2"applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr6ft",3"declared_data": {4"name": "Hannah Bret",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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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": "Hannah Bret",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}
The response returns the verification ID, prefixed with idv_
.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_inconclusive
first attempt webhook returns the response code starting with 61
that you provided for external_applicant_id
.
When the identity_verification_checks_inconclusive
webhook returns retry_required
status, create another attempt.
Call the Create an attempt endpoint, and provide the verification ID as the {identity_verification_id}
path parameter.
For example, the id
returned here 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": "2025-07-21T17:32:28Z",4"modified_on": "2025-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}
The identity_verification_checks_completed
final result webhook returns the response code starting with 62
that you provided for external_applicant_id
.
Optionally, you can retrieve the verification.