Access1

Address Document Verification8

Agentic Commerce Protocol1

AML Screening2

Apple Pay3

Applicants4

Bacs Direct Debit1

Balances2

Business details2

Card metadata1

Card testing5

Cardholder access tokens1

Cardholders4

Cards11

Compliance requests2

Control groups4

Control profiles7

Controls5

Customers4

Digital cards1

Disputes12

Face Authentication7

Financial actions1

Flow3

Forex1

Forward6

Google Pay4

Hosted Payments Page2

ID Document Verification8

Identity Verification9

Instruments5

Inventory15

Issuing disputes6

Network Tokens4

Onboarding6

Onboarding Simulator5

Out-of-band authentication simulator1

Payment Context2

Payment instruments4

Payment Links2

Payment Methods1

Payment Setups4

Payments11

Payout schedules2

platforms4

Platforms4

Reports3

Representatives2

Standalone5

Standalone Account Updater1

Tokens2

Transactions2

Transfers2

Workflows21

Identity Verification

Create an identity verification and attempt

Beta Create an identity verification and an initial attempt.

If successful, you receive a 201 Created response and the identity verification resource, which contains the attempt URL.

Ensure you use your identity verification configuration ID.

post/create-and-open-idv

Request

Base URL
https://identity-verification.checkout.com
Auth
- OAuth 2
  Client credentials
  Token URLstring
  Scopesidentity-verification
- or API key in header Authorization
TypeScript
https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/create-and-open-idv/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

created_onstring date-time required

The date and time when the resource was created, in UTC. Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. Format – yyyy-mm-ddThh:mm:ss.sss

user_journey_idstring

Your configuration ID.

applicant_idstring

The applicant's unique identifier.

The verification status.

risk_labelsIdvRiskLabel[] required

One or more codes that provide more information about risks associated with the verification.

verification_policy_versionstring

The version of the verification policy applied. Only returned for certified verifications.

redirect_urlstring uri required

The URL to redirect the applicant to after the attempt.

idstring required

The identity verification's unique identifier.

Example request

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "user_journey_id": "usj_tkoi5db4hryu5cei5vwoabr7we",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "response_codes": [
    {
      "summary": "document_front_not_captured"
    }
  ],
  "verified_identity": {
    "nationality": "US"
  },
  "certifications": [
    {
      "data": {
        "right_to_work": "GRANTED"
      }
    }
  ],
  "declared_data": {
    "name": "Hannah Bret",
    "birth_date": "1994-10-15T00:00:00.0000000",
    "phone_number": {
      "country_code": "+33",
      "number": "5555550102"
    },
    "email": "hannah.bret@example.com",
    "address": {
      "address_line1": "123 Main Street",
      "address_line2": "Apt 4B",
      "city": "London",
      "state": "Greater London",
      "zip": "SW1A 1AA",
      "country": "GB"
    }
  },
  "documents": [
    {
      "nationality": "US",
      "document_issuing_country": "US",
      "address": "123 Main Street, London, SW1A 1AA",
      "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"
    }
  ],
  "face": {
    "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"
  },
  "id": "idv_tkoi5db4hryu5cei5vwoabr7we"
}

Response

Identity verification and attempt created successfully