Sample Input

Input Example Version 3

Request Code Block
{
    "base64ImageString": "/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "backImage":"/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "apiKey":"API_KEY",               
    "imageFormat":".jpg",
    "imageEnabled":true,
    "faceImageEnabled": true,
    "docTypeEnabled":true
}

The "docTypeEnabled" parameter is to return the Document Type that is submitted through the OkayID.

Input Example Version 2

Request Code Block
{
    "base64ImageString": "/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "backImage":"/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "apiKey":"API_KEY",               
    "imageFormat":".jpg",
    "imageEnabled":true,
    "faceImageEnabled": true
}

The "faceImageEnabled" parameter is to return a cropped portrait face image from the Id Card.

Input Example Version 1

Request Code Block
{
    "base64ImageString": "/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "backImage":"/9j/4AAQSkZJRgAB...wEwJefc\r\nf//Z\r\n",
    "apiKey":"API_KEY",               
    "imageFormat":".jpg",
    "imageEnabled":true
}

The "imageFormat" parameter can leave it blank if the format of the image is unknown;

The "imageEnabled" parameter is to return a cropped photo of the ID card without background.

Last updated