Skip to content

Retrieve form URL

Request

Retrieve URL for a form

Security
API-Key
Path
form_idstring or null, = 36 charactersrequired

A unique identifier of a form, assigned by our system after it is created in the Dashboard

Example:27c5caea93ee4656881ef9a30fadd21a3768
Bodyapplication/json
applicant_idstring, = 36 characters

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
external_applicant_idstring or null, [ 0 .. 50 ] characters

A unique identifier of your user in your system

Example:"8ba166fd-e9ba-49c6-b91a-fdbf0f63f939"
redirect_urlstring or null, <= 2048 characters

The URL in your system to which a user will be redirected after completing and submitting a form

Example:"https://kyc.example.com/complete"
document_idsArray of strings

A list of document IDs to attach to the verification created from this form. Requires applicant_id to also be provided

Example:
[
  "b81e4d07c2a94f5e9d63a0c17f2e85b4d906",
  "5c3fa972e10b48d6a7f4c28e9b05d13e6a7c"
]
{
  "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "external_applicant_id": "8ba166fd-e9ba-49c6-b91a-fdbf0f63f939",
  "redirect_url": "https://kyc.example.com/complete",
  "document_ids": [
    "b81e4d07c2a94f5e9d63a0c17f2e85b4d906",
    "5c3fa972e10b48d6a7f4c28e9b05d13e6a7c"
  ]
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
form_idstring or null, = 36 characters

A unique identifier of a form, assigned by our system after it is created in the Dashboard

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
form_urlstring, <= 2048 characters

A one-time URL to a form that includes a form token. The form remains open for completion via the URL until a user completes it

Example:"https://forms.kycaid.com/27c5caea93ee4656881ef9a30fadd21a3768"
verification_idstring or null, = 36 characters

A unique identifier for a verification, assigned by our system after a verification is created using the “Create a verification" request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
form_tokenstring, = 36 characters

A unique token for a form, generated by our system, and included as part of a form URL

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
verification_attempts_leftinteger or null, (number)

A number of verification attempts available for a user, set in form settings in the Dashboard. A null value means “not limited”. It equals 0 if set in the settings

Example:5
Response
{
  "form_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "form_url": "https://forms.kycaid.com/27c5caea93ee4656881ef9a30fadd21a3768",
  "verification_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "form_token": "27c5caea93ee4656881ef9a30fadd21a3768",
  "verification_attempts_left": 5
}