Response Parameters

Returns following user details in JSON format:

#

Field Name

Description

Type

Max Length

Mandatory [Yes/No]

1

Status

Response status code

String

200

Yes

2

StatusDescription

Response status description

String

100

Yes

3

SessionID

Client application identifier for the current session if any

String

250

Yes

4

MatchPercentage

Indicates the matching percentage of the live photo against the photo of any applicant’s documents as

specified

String

5

Yes

5

LivelinessStatus

Liveliness status of the photo if request has opted for liveliness.

Valid values are Y / N

String

1

Yes

Sample Decryption Response:

{ 
X6vPB7pLvqNX5dXk1pycEqdO3ZlcBApF2v1J2dpfObOhBNcVl2v/w3RM9DepF3rTUktV5D5u6Jz7SNFw1A MGrhFUKXl2Ul34X+X6vPB7pLvqNX5dXk1pycEqdO3ZlcBApF2v1J2dpfObOhBNcVl2v/w3RM9DepF3rTU ktV5D5u6Jz7SNFw1AMGrhFUKXl2Ul34XZALUFN1BrLtJLEMW2OPbZXaL5E9DT0liidq+ +0liidq /q4Aal4sHh/nYtga23bfY4DY+X6vPB7pLvqNX5dXk1pycEqdO3ZlcBApF2v1J2dpfObOhBNcVl2v/w3RM9De pF3rTUktV5D5u6Jz7Sq4Aal4sHhriMfCMx8…………...1AMGrhFUKXl2Ul34X+0liidq+X6vPB7pLvqNX5dX k1pycEqdO3ZlcBApF2v1J2dpfObOhBNcVl2v/w3RM9DepF3rTUktV5D5u6Jz7Sq4Aal4sHh/= 
} 

Sample Plain Response:

{ 
    "Status": "CSS041", 
    "StatusDecription": "Face Match Validation Completed", 
    "SessionID": "26454520426145353738_BoTVKsp0yz", 
    "MatchPercentage": "50", 
    "LivelinessStatus":  "Y" 
} 

Sample Failure Plain Response:

{ 
  "Status": "CSS002", 
  "StatusDecription": "Invalid request",   "SessionID": "20220426145353738_BoTVKsp0yz" 
} 

Response Status Code and Status Description:

If the request fails, corresponding status code will be returned along with the status description in the response parameter.

The following table lists the possible response status codes and description.

#

Status

Code

Status Description

1

CSS001

Your request decryption failed

2

CSS002

Invalid Request

3

CSS003

User id or password is mantuary fielded

4

CSS004

API authentication failed

5

CSS005

Client setup pending

6

CSS006

Client is currently Inactive

7

CSS007

Your password is expired

8

CSS008

Liveness API not allowed

9

CSS009

Image is empty

10

CSS010

Invalid image format

11

CSS011

Liveness configuration failed

12

CSS012

We are experiencing technical issues at the moment with one or more of our partners. Please try again later. Regret inconvenience

13

CSS013

We are unable to process the image. Please check if a lower resolution/sized image can be taken by your system and re-take your photo

14

CSS014

We are unable to process your photo. Please re-take.

15

CSS015

Ensure the face is completely visible in the frame and re-take your photo. Face too away from camera

16

CSS016

Ensure the face is completely visible in the frame and re-take your photo. Face too close to camera

17

CSS017

Please ensure the face is completely visible in the photo. We are unable to process the submitted image.

18

CSS400

Request is empty

19

CSS500

Internal Error

20

CSS037

Face Match not allowed

21

CSS038

Face Match configuration failed

Last updated