Skip to main content
POST
/
v1
/
kyc
/
sessions
Create hosted KYC session
curl --request POST \
  --url https://api.verisecid.com/v1/kyc/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirectUrl": "<string>",
  "metadata": {},
  "firstName": "<string>",
  "lastName": "<string>"
}
'
{
  "sessionId": "<string>",
  "verificationUrl": "<string>",
  "workspaceId": "<string>",
  "userId": "<string>",
  "status": "not_started",
  "createdAt": "2023-11-07T05:31:56Z",
  "kycStatus": "Approved",
  "updatedAt": "2023-11-07T05:31:56Z",
  "redirectUrl": "<string>",
  "metadata": {},
  "applicantFirstName": "<string>",
  "applicantLastName": "<string>",
  "applicant": "<string>",
  "detectedDocumentType": "<string>",
  "expectedDocumentType": "<string>",
  "retryAttempt": 123,
  "document": {},
  "face": {},
  "overall": {},
  "images": {
    "documentFrontPath": "<string>",
    "documentFrontUrl": "<string>",
    "documentBackPath": "<string>",
    "documentBackUrl": "<string>",
    "selfiePaths": [
      "<string>"
    ],
    "selfieUrls": [
      "<string>"
    ]
  },
  "verification": {
    "pass": true,
    "document": {},
    "face": {},
    "overall": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
redirectUrl
string<uri>
​
metadata
object
​
firstName
string

Applicant first name

​
lastName
string

Applicant last name

Response

Session created

​
sessionId
string
required
​
verificationUrl
string<uri>
required
​
workspaceId
string
required
​
userId
string
required
​
status
enum<string>
required
Available options:
not_started,
processing,
completed,
failed
​
createdAt
string<date-time>
required
​
kycStatus
enum<string> | null
Available options:
Approved,
Submitted,
Declined,
​
updatedAt
string<date-time>
​
redirectUrl
string<uri> | null
​
metadata
object
​
applicantFirstName
string | null
​
applicantLastName
string | null
​
applicant
string | null

Full applicant name

​
detectedDocumentType
string | null
​
expectedDocumentType
string | null
​
retryAttempt
integer

Number of retry attempts

​
document
object

Extracted document details and scores

​
face
object

Face match details

​
overall
object

Overall verification result

​
images
object
​
verification
object