Face Authentication webhooks
Last updated: January 15, 2025
The Face Authentication solution returns webhook notifications for the following events:
1{2"id": "evt_wulgj7iilg2u3lweve5g7oc5xa",3"type": "face_authentication_created",4"version": "1.2.0",5"created_on": "2024-12-05T17:48:25.999831Z",6"data": {7"applicant_id": "aplt_01jebyzk8nz6j206x4hr02xywj",8"external_applicant_id": "eaplt_10000000000000000000000000",9"status": "created",10"face_authentication_id": "fav_01jebyzxdkj4e2mktk36q0fpak",11"response_codes": [],12"user_journey_id": "usj_01heqt35wmjrf3wjd7w1wz33p2"13},14"_links": {15"self": {16"href": "https://api.checkout.com/workflows/events/evt_wulgj7iilg2u3lweve5g7oc5xa"17}18}19}
1{2"id": "evt_6wld3spaaa6evlvb4bovk5r57m",3"type": "face_authentication_link_expired",4"version": "1.2.0",5"created_on": "2024-12-05T17:49:03.890067Z",6"data": {7"applicant_id": "aplt_01jeby3q6qd5zgrdttnzfsx5wj",8"status": "retry_required",9"face_authentication_id": "fav_01jeby3q8kzbeayxc0whnjts8k",10"response_codes": [11{12"code": 61101,13"summary": "applicant_never_started"14}15],16"user_journey_id": "usj_01heqt35wmjrf3wjd7w1wz33p2"17},18"_links": {19"self": {20"href": "https://api.checkout.com/workflows/events/evt_6wld3spaaa6evlvb4bovk5r57m"21}22}23}
1{2"id": "evt_uqyk4lgloeduvarejyl2we7y5y",3"type": "face_authentication_audit_completed",4"version": "1.2.0",5"created_on": "2024-12-05T18:32:39.39415Z",6"data": {7"applicant_id": "aplt_01jec137ejpfr42eze4y46hs9g",8"external_applicant_id": "eaplt_61411I10000000000000000000",9"status": "approved",10"face_authentication_id": "fav_01jec13b0w7rxkarqarmx1jq6z",11"response_codes": [12{13"code": 10000,14"summary": "approved"15}16],17"user_journey_id": "usj_01heqt35wmjrf3wjd7w1wz33p2"18},19"_links": {20"self": {21"href": "https://api.checkout.com/workflows/events/evt_uqyk4lgloeduvarejyl2we7y5y"22}23}24}
Field name | Description |
---|---|
string | The unique identifier for the event. |
string | The event type. |
string | The version of the Face Authentication solution used. |
datetime | The date and time when the event was triggered, in UTC. |
object | The webhook message. |
string | The unique identifier for the user. |
string | Your unique identifier for the user. |
string | |
string | The unique identifier for the face authentication. |
object | The response code providing more information. This is returned for the following events:
|
integer | The response code. |
string | The summary that explains the response code. |
string | Your Face Authentication user journey ID. |
string | The URL to the event. |