API Docs

Photo Verification API

post
https://api.zwitch.io/v1/kycs/photo-match

Use the below API to verify an uploaded photo against their photo in the Aadhaar or CKYC database.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The database against which you want to verify the uploaded photo.

Possible values

  • aadhaar
  • ckyc

string

Required when type is aadhaar

Unique identifier of the Aadhaar verification request in ZWITCH.

Example: adh_SQMGqA448nF7VhzYhpnPt0qNl

Use our Aadhaar Verification via OTP APIs to verify the individual's Aadhaar.

string

Required when type is ckyc

Unique identifier of the CKYC request in the CKYC database.

Example: ckyc_SQMGqA448nF7VhzYhpnPt0qNl

Use our CKYC Search API to check if the individual is registered in the CKYC database.

string
required

Unique identifier of the upload document request in ZWITCH.

Example: doc_qsUwixnXwHI4tZLQnbf1xn2tQ

Use our Upload Document API to upload the individual's photo to our database.

int32
required

The minimum acceptable match score set by you.

  • Minimum value: 1
  • Maximum score: 100
  • Whole numbers only
Example: 75

metadata
object

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.”

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 2 years ago