Start the IDnow video identification session

POST /users/{user_id}/kyc/identities/{identity_id}/video_identifications

Start the IDnow video identification session. In order to start a video identification session, the identity terms need to be accepted through the identity_terms POST method. An identity with address and bank account needs to exist before starting the identification.

Path parameters

  • user_id string Required

    User id

  • identity_id string Required

    Identity or Legal representative id

Responses

  • 201

    An empty video identification created and returned

    Hide response attributes Show response attributes object
    • id string(uuid)
    • identity_id string(uuid)
    • idnow_id string
    • redirect_url string
    • statuses array[string]
    • data object
    • url string
    • has_files boolean
    • completed boolean
    • success boolean
    • rejected boolean
    • pending boolean
    • reason string
    • identificationtime string(datetime)
    • status string
  • 401

    Authorization information is missing or invalid.

  • 422

    Request body has errors or invalid.

POST /users/{user_id}/kyc/identities/{identity_id}/video_identifications
curl \
 -X POST https://client-subdomain.bitbond.net/api/v1/users/{user_id}/kyc/identities/{identity_id}/video_identifications
Response examples (201)
{
  "id": "string",
  "identity_id": "string",
  "idnow_id": "string",
  "redirect_url": "string",
  "statuses": [
    "string"
  ],
  "data": {},
  "url": "string",
  "has_files": true,
  "completed": true,
  "success": true,
  "rejected": true,
  "pending": true,
  "reason": "string",
  "identificationtime": "string",
  "status": "string"
}
Response examples (201)
{
  "id": "string",
  "identity_id": "string",
  "idnow_id": "string",
  "redirect_url": "string",
  "statuses": [
    "string"
  ],
  "data": {},
  "url": "string",
  "has_files": true,
  "completed": true,
  "success": true,
  "rejected": true,
  "pending": true,
  "reason": "string",
  "identificationtime": "string",
  "status": "string"
}