---
title: "Create an eKYC check"
method: POST
path: "/v1/checks/ekyc"
tags: ["eKYC check"]
---

# Create an eKYC check

`POST /v1/checks/ekyc`

Create an eKYC check. The check will verify the identity of the individual using electronic Know Your Customer (eKYC) data sources.

## Request body

- EkycCheckCreate
  - `individual_id` string, uuid, required
  - `settings` EkycCheckSettingsCreate
    - `vendor` 'gbg' — Vendor to use for eKYC verification. Currently only `gbg` is supported.
    - `automatic_approval` boolean
    - `automatic_rejection` boolean

## Response `201`

eKYC check has been created

**ℹ️ Click to see full payload**

- EkycCheck
  - `id` string, uuid, required
  - `individual_id` string, uuid, required
  - `is_internal` boolean, required
  - `status` 'in_progress' | 'need_review' | 'processing' | 'approved' | 'rejected' | 'expired', required — ℹ️ Check status `expired` is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
  - `type` 'ekyc', required
  - `subtype` string, nullable, required — Currently always null for `ekyc` Check
  - `last_activity_at` string, date-time, required — Latest activity date Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
  - `data` EkycCheckData, required
    - `result` 'approved' | 'rejected' | 'error', nullable, required
    - `decision` 'match' | 'inconclusive' | 'inconsistent', nullable, required
    - `settings` EkycCheckDataSettings, required
      - `vendor` 'gbg', required
      - `automatic_approval` boolean, required
      - `automatic_rejection` boolean, required
    - `vendor` EkycCheckDataVendor, required
      - `name` 'gbg', required
      - `profile_id` string, required
      - `profile_name` string, nullable, required
      - `country` string, alpha-2, required — [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)
      - `score` number, nullable, required
    - `review` Review, required
      - `comment` string, nullable, required
      - `reviewed_at` string, date-time, nullable, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)
      - `reviewer_type` 'user' | 'system' | 'api', nullable, required
      - `user` NestedUser, required
        - `id` string, uuid, required
        - `first_name` string, required
        - `last_name` string, required
        - `email` string, email, required
    - `information` EkycCheckDataInformation, required
      - `first_name` string, nullable, required
      - `last_name` string, nullable, required
      - `birth_date` string, nullable, required
      - `address` Address, required
        - `street_address` string, nullable, required
        - `street_address_2` string, nullable, required
        - `postal_code` string, nullable, required
        - `city` string, nullable, required
        - `state` string, nullable, required
        - `region` string, nullable, required
        - `country` string, alpha-2, nullable, required — [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)
    - `ai` EkycCheckDataAi, required
      - `interpretation` string, nullable, required

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - Make sure the body payload matches the expected schema - Limit reached. Contact us at support@dotfile.com to lift all limits.

---

[API](https://skmtc.dev/dotfile/apis/api-specifications.md) · [All operations](https://skmtc.dev/dotfile/apis/api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dotfile/api-specifications/revisions/36393567057b/schema)