Create KYC form entry

Create KYC Form Entry

POST/organizations/{organizationId}/kyc-forms/{kycFormId}/entries

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

kycFormId*string (uuid)

Body

application/json

locale*Locale (enum)

afsqarazbnbgcazh-CNzh-HKzh-TWhrcsdanlenen-GBen-USetfilfifrkadeelguhahehihuidgaitjaknkkrw-RWkoky-KGlolvltmkmsmlmrnbfaplpt-BRpt-PTparorusrsksleses-ARes-ESes-MXswsvtatethtrukuruzvizu

answers*array of FormEntryAnswer (one of)

statusformEntryStatus (enum)

The status of the form entry.

draftsubmittedapprovedrejected

Response

201403404422

OK

Body

application/json

id*string (uuid)

organizationId*string (uuid)

formId*string (uuid)

locale*Locale (enum)

afsqarazbnbgcazh-CNzh-HKzh-TWhrcsdanlenen-GBen-USetfilfifrkadeelguhahehihuidgaitjaknkkrw-RWkoky-KGlolvltmkmsmlmrnbfaplpt-BRpt-PTparorusrsksleses-ARes-ESes-MXswsvtatethtrukuruzvizu

status*formEntryStatus (enum)

The status of the form entry.

draftsubmittedapprovedrejected

answers*array of FormEntryAnswer (one of)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/kyc-forms/{kycFormId}/entries', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "locale": [
        "en",
        "pt-BR"
      ],
      "answers": [
        {
          "key": "text",
          "valueString": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

201403404422

{
  "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": false
    }
  ],
  "createdAt": "2024-12-21T12:07:33.230Z",
  "updatedAt": "2024-12-21T12:07:33.230Z"
}