Object

The response object depends on the database against which you are verifying the uploaded photo.

The table below lists the possible response objects.

Type	Response Object
`aadhaar`	`photo_match.aadhaar`
`ckyc`	`photo_match.ckyc`

Photo Verification - Aadhaar Object

Shown below is a sample photo_match.aadhaar object.

{
  "id": "phm_6wnlsN9n1LqrvER1O1L3flEF7",
  "object": "photo_match.aadhaar",
  "type": "aadhaar",
  "aadhaar_verification_id": "adh_SQMGqA448nF7VhzYhpnPt0qNl/",
  "document_id": "doc_qsUwixnXwHI4tZLQnbf1xn2tQ",
  "minimum_match_score": 75,
  "status": "success",
  "match_score": 99.97,
  "review_needed": false,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "created_at": 1656417101,
  "updated_at": 1656417101,
  "is_sandbox": true
}

The table below lists the various parameters in the photo_match.aadhaar objects.

Parameter	Type	Description
id	`string`	Unique identifier of the photo verification request in the ZWITCH database. Example: `phm_M9BlSe5AHP2iRi3oR8gp6rjBp`
object	`string`	API object returned. Possible value: `photo_match.aadhaar`
type	`string`	The database against which you want to verify the the uploaded photo. Possible value: `aadhaar`
aadhaar_verification_id	`string`	Unique identifier of the Aadhaar verification request in the ZWITCH database. Example: `adh_SQMGqA448nF7VhzYhpnPt0qNl` Use our Aadhaar Verification via OTP APIs to verify the individual's Aadhaar and get the unique identifier.
document_id	`string`	Unique identifier of the photo uploaded to the ZWITCH database. Example: `doc_qsUwixnXwHI4tZLQnbf1xn2tQ` Use our Upload Document API to upload the individual's photo to our database.
minimum_match_score	`integer`	The minimum acceptable match score set by you. Minimum value: `1` Maximum score: `100` Whole numbers only Example: `75`
status	`string`	The status of the photo verification request. Possible values: `success`: The API call was successful. `failed`: The API call failed.
match_score	`float`	The match score returned by our service provider after comparing the uploaded photo against the individual's photo in the Aadhaar databases. Example: `99.96`
review_needed	`string`	Lets you know if you need to manually review the documents to take a decision. Possible values: `true`: Match score returned by our service provider is lesser than the minimum match score provided by you. `false`: Match score returned by our service provider is greater than the minimum match score provided by you.
metadata	`object`	Object of key-value pair that can be used to store additional information about the entity. Each pair cannot exceed 256 characters. Maximum 5 key-value pairs. Example: `"key_1": "Zwitch to the moon.”`
created_at	`integer`	Unix timestamp when the photo verification API request was received by ZWITCH. Example: `1656417101`
updated_at	`integer`	Unix timestamp when the photo verification API request was successfully processed. Example: `1656417101`
is_sandbox	`boolean`	Mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode `false`: API was triggered in live mode

Photo Verification - CKYC Object

Shown below is a sample photo_match.ckyc` object.

{
  "id": "phm_mDJezeS7z3tBJzv5qlQOJIvWA",
  "object": "photo_match.ckyc",
  "type": "ckyc",
  "ckyc_verification_id": "ckyc_SQMGqA448nF7VhzYhpnPt0qNl/",
  "document_id": "doc_qsUwixnXwHI4tZLQnbf1xn2tQ",
  "minimum_match_score": 75,
  "status": "success/failed",
  "match_score": 99.97,
  "review_needed": false,
  "metadata": {
    "key_1": "DD",
    "key_2": "XOF"
  },
  "created_at": 1656417101,
  "updated_at": 1656417101,
  "is_sandbox": true
}

The table below lists the various parameters in the photo_match.ckyc objects.

Parameter	Type	Description
id	`string`	Unique identifier of the photo verification request in the ZWITCH database. Example: `phm_M9BlSe5AHP2iRi3oR8gp6rjBp`
object	`string`	API object returned. Possible value: `photo_match.ckyc`
type	`string`	The database against which you want to verify the the uploaded photo. Possible value: `ckyc`
ckyc_verification_id	`string`	Unique identifier of the Check CKYC Registration request in the ZWITCH database. Example: `ckyc_yNLB19Y0NCLsDt50fR252qq3b` Use our Check CKYC Registration API to check if an individual is registered in the CKYC database and get the unique identifier.
document_id	`string`	Unique identifier of the photo uploaded to the ZWITCH database. Example: `doc_qsUwixnXwHI4tZLQnbf1xn2tQ` Use our Upload Document API to upload the individual's photo to our database.
minimum_match_score	`integer`	The minimum acceptable match score set by you. Minimum value: `1` Maximum score: `100` Whole numbers only Example: `75`
status	`string`	The status of the photo verification request. Possible values: `success`: The API call was successful. `failed`: The API call failed.
match_score	`integer`	The match score returned by our service provider after comparing the uploaded photo against the individual's photo in the CKYC databases. Example: `99.96`
review_needed	`string`	Lets you know if you need to manually review the documents to take a decision. Possible values: `true`: Match score returned by our service provider is lesser than the minimum match score provided by you. `false`: Match score returned by our service provider is greater than the minimum match score provided by you.
metadata	`object`	Object of key-value pair that can be used to store additional information about the entity. Each pair cannot exceed 256 characters. Maximum 5 key-value pairs. Example: `"key_1": "Zwitch to the moon.”`
created_at	`integer`	Unix timestamp when the photo verification API request was received by ZWITCH. Example: `1656417101`
updated_at	`integer`	Unix timestamp when the photo verification API request was successfully processed. Example: `1656417101`
is_sandbox	`boolean`	Mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode `false`: API was triggered in live mode