Identity verifications

Create and start an identity verification

This endpoint allows you to create and identity verification. You should get a 201 response and the identity verification resource containing the _links/verification_url.

post/v2/create-and-start-idv

Request

Base URL
https://api.ubble.ai
Auth
none declared
TypeScript
https://skmtc.dev/ubble/apis/checkout-com-identity-verification/docs/v2/create-and-start-idv/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

user_journey_idstring

User journey unique identifier.

applicant_idstring

Applicant unique identifier.

webhook_urlstring uri

Example request

{
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we"
}

Response

Identity verification created

idstring required

Identity verification unique identifier.

redirect_urlstring uri required

created_onstring date-time required

UTC Date time when the resource was created

modified_onstring date-time required

UTC Date time when the resource was modified

Status of the verification.

verification_policy_versionstring

returned ONLY for certified verifications

risk_labelsRiskLabel[] required

Risk assessment labels

user_journey_idstring required

User journey unique identifier.

applicant_idstring required

Applicant unique identifier.

webhook_urlstring uri required

Example response

{
  "id": "idv_tkoi5db4hryu5cei5vwoabr7we",
  "phone_number": {
    "country_code": "+33",
    "number": "2068133616"
  },
  "created_on": "2017-07-21T17:32:28Z",
  "modified_on": "2017-07-21T17:40:32Z",
  "documents": [
    {
      "document_issuing_country": "US",
      "front_image_signed_url": "https://storage-b.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",
      "back_image_signed_url": "https://storage-b.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",
      "signature_image_signed_url": "https://storage-b.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",
      "nationality": "US",
      "gender": "M"
    }
  ],
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we"
}

Changes

No recorded changes to this operation across all 1 revision of this API.