Response Parameter

Returns following user details in JSON format:

#

Field

Name

Description

Type

Max Length

Required

[Yes/No]

1

SessionID

Client application identifier for the current session if any inputted

String

250

Yes

2

Status

Success/Failure with error codes

String

200

Yes

3

StatusDescri ption

Response status description

String

100

Yes

4

Document1

Return Document Reference number

VC

50

Yes

5

Address 1

Return the Address line 1 as read from the OVD

VC

250

Yes

6

Address 2

Return the Address line 2 as read from the OVD

VC

250

No

7

Address 3

Return the Address line 3 as read from the OVD

VC

250

No

8

Pincode

Return the Pin code as read from the

OVD

String

6

Yes

9

City

Return the City as read from the

OVD

String

100

Yes

10

State

Return the State as read from the

OVD

String

100

Yes

11

DocumentE xpiryDate

Return the Expiry Date of the Document (Only for Passport)

VC

50

No

Sample Decryption Response:

{ 
"uYM4ugEh/ZALUFN1BrLtJLEMW2OPbZXaL5E9DT0liidq+X6vPB7pLvqNX5dXk1pycEqdO3ZlcBApF2v1
J2dpfObOhBNcVl2v/w3RM9DepF3rTUktV5D5u6Jz7SNFw1AMGrhFUKXl2Ul34X+0liidq+X6vPB7pLvqNX
5dXk1pycEqdO3ZlcBApF2v1J2dpfObOhBNcVl2v/w3RM9DepF3rTUktV5D5u6Jz7Sq4Aal4sHh/q4Aal4sHh/n Ytga23bfY4DY+riMfCMx8…………...1AMGrhFUKXl2Ul34X+0liidq+X6vPB7pLvqNX5dXk1pycEqdO3Zlc BApF2v1J2dpfObOhBNcVl2v/w3RM9DepF3rTUktV5D5u6Jz7Sq4Aal4sHh/ =" 
} 

Sample Plain Response:

{ 
  "SessionID": "26454520426145353738_BoTVKsp0yz", 
  "Status": "CSS040", 
  "StatusDecription": "OVD OCR Completed", 
  "Document1": "Passport", 
  "Address1": "8/45 American church ", 
  "Address2": "Annamalai Nagar", 
  "Address3": "ktc dippo opposite", 
  "Pincode": "628000", 
  "City": "Chennai", 
  "State": "Tamilnadu", 
  "DocumentExpiryDate": "DD-MM-YY" 
}  

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 a mandatory field

4

CSS004

API authentication failed

5

CSS005

Client setup pending

6

CSS006

Client is currently Inactive

7

CSS007

Your password has expired

8

CSS009

Image is empty

9

CSS010

Invalid image format

10

CSS012

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

11

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 photo

12

CSS014

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

13

CSS015

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

14

CSS016

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

15

CSS017

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

16

CSS018

SessionID is mandatory field

17

CSS019

Invalid Pan

18

CSS031

OVD OCR API not allowed

19

CSS032

OVD OCR configuration failed

20

CSS033

Document Front Page Should not be empty

21

CSS034

Document Type Should not be empty

22

CSS400

Request is empty

23

CSS500

Internal Error

24

CSS008

Unauthorized API access

Last updated