Create KYC form entry

Create KYC Form Entry

post

Authorizations

useraccessKey

Path parameters

organizationIdstringrequired

The organization ID

kycFormIdstring · uuidrequired

Body

localestring · enumrequired

Example: ["en","pt-BR"]

Options: af, sq, ar, az, bn, bg, ca, zh-CN, zh-HK, zh-TW, hr, cs, da, nl, en, en-GB, en-US, et, fil, fi, fr, ka, de, el, gu, ha, he, hi, hu, id, ga, it, ja, kn, kk, rw-RW, ko, ky-KG, lo, lv, lt, mk, ms, ml, mr, nb, fa, pl, pt-BR, pt-PT, pa, ro, ru, sr, sk, sl, es, es-AR, es-ES, es-MX, sw, sv, ta, te, th, tr, uk, ur, uz, vi, zu

answersone of[]required

statusstring · enumoptional

The status of the form entry.

Options: draft, submitted, approved, rejected

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/kyc-forms/{kycFormId}/entries' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "locale": [
      "en",
      "pt-BR"
    ],
    "answers": [
      {
        "key": "text",
        "valueString": "text",
        "isDefault": true
      }
    ],
    "status": "draft"
  }'

201

403

404

422

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "formId": "123e4567-e89b-12d3-a456-426614174000",
  "locale": [
    "en",
    "pt-BR"
  ],
  "status": "draft",
  "answers": [
    {
      "key": "text",
      "valueString": "text",
      "isDefault": true
    }
  ],
  "createdAt": "2025-03-28T18:42:35.912Z",
  "updatedAt": "2025-03-28T18:42:35.912Z"
}

OK