Matcher API (2021-06-12T00:51:52Z)

Download OpenAPI specification:Download

Matcher API to perform facial recognition functions.

Authentication

matcher-api-admin-auth

Security Scheme Type	API Key
Header parameter name:	Authorization

matcher-api-user-auth

Security Scheme Type	API Key
Header parameter name:	Authorization

Delete User

Allows a matcher admin to delete a matcher user or admin. Requires a valid JWT.

Authorizations:

matcher-api-admin-auth

Request Body schema: application/json

username required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"result": "Success"
}

Identify

Allows authorized users to identify a Base-64 encoded photo (or pre-computed template) against a list of facial recognition galleries. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Request Body schema: application/json

Any of

galleries	Array of strings non-empty unique
photo required	string^[A-Za-z0-9+/]+={0,2}$
	object
top	integer [ 1 .. 250 ]
threshold	number [ 0.01 .. 1 ]

Responses

Request samples

Payload

Content type

application/json

{"galleries": ["string"
],
"photo": "string",
"template": {"details": {"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
},
"embedding": {"sdkVersion": "string",
"modelName": "string",
"featureVector": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
},
"top": 1,
"threshold": 0.01
}

Response samples

Content type

application/json

{"took": 0,
"matches": [{"confidence": 0,
"personId": "string",
"photoId": "string",
"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"eyeDistance": 0,
"gallery": "string"
}
],
"photoDetails": {"topLeft": {"x": 0,
"y": 0
},
"bottomRight": {"x": 0,
"y": 0
},
"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
],
"detailedLandmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
}
}

Login

Allows authorized users to log into the matcher serivce. Produces a JWT with a 1-hour expiry that can be used in subsequent API function calls.

Request Body schema: application/json

username required	string
password required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"token": "string"
}

Deactivate User

Allows a matcher admin to deactivate a matcher user or admin. Requires a valid JWT.

Authorizations:

matcher-api-admin-auth

Request Body schema: application/json

username required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"result": "Success"
}

List Galleries

Allows authorized users to list all facial recognition galleries. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Responses

Response samples

Content type

application/json

{"galleries": [{"gallery": "string",
"count": 0
}
]
}

Change Password

Allows users to change their password.

Request Body schema: application/json

username required	string
password required	string
newPassword required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"newPassword": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"result": "Success"
}

Verify

Allows authorized users to compare two Base-64 encoded photos (or pre-computed templates) to verify identity. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Request Body schema: application/json

Any of

probePhoto required	string^[A-Za-z0-9+/]+={0,2}$
targetPhoto required	string^[A-Za-z0-9+/]+={0,2}$
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"probePhoto": "string",
"targetPhoto": "string",
"probeTemplate": {"details": {"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
},
"embedding": {"sdkVersion": "string",
"modelName": "string",
"featureVector": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
},
"targetTemplate": {"details": {"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
},
"embedding": {"sdkVersion": "string",
"modelName": "string",
"featureVector": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
}
}

Response samples

Content type

application/json

{"confidence": 0,
"probeDetails": {"topLeft": {"x": 0,
"y": 0
},
"bottomRight": {"x": 0,
"y": 0
},
"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
],
"detailedLandmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
},
"targetDetails": {"topLeft": {"x": 0,
"y": 0
},
"bottomRight": {"x": 0,
"y": 0
},
"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
],
"detailedLandmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
}
}

Delete Gallery

Allows authorized users to delete a facial recognition gallery. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Request Body schema: application/json

gallery

required

string^((?!xn--)[a-z0-9][a-z0-9-]{1,52}[a-z0-9])$|^...

Responses

Request samples

Payload

Content type

application/json

{"gallery": "string"
}

Response samples

Content type

application/json

{"result": "Success"
}

Delete Photo

Allows authorized users to delete all enrolled templates from a gallery associated with a personId and/or photoId. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Request Body schema: application/json

gallery required	string^((?!xn--)[a-z0-9][a-z0-9-]{1,52}[a-z0-9])$\|^...
personId required	string^([A-Za-z0-9-]+)$
photoId	string^([A-Za-z0-9-]+)$

Responses

Request samples

Payload

Content type

application/json

{"gallery": "string",
"personId": "string",
"photoId": "string"
}

Response samples

Content type

application/json

{"count": 0
}

Enroll Photo

Allows authorized users to enroll a Base-64 encoded photo (or pre-computed template) into a facial recognition gallery. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Request Body schema: application/json

Any of

gallery required	string^((?!xn--)[a-z0-9][a-z0-9-]{1,52}[a-z0-9])$\|^...
photo required	string^[A-Za-z0-9+/]+={0,2}$
	object
personId required	string^([A-Za-z0-9-]+)$
photoId required	string^([A-Za-z0-9-]+)$

Responses

Request samples

Payload

Content type

application/json

{"gallery": "string",
"photo": "string",
"template": {"details": {"quality": 0,
"hasMask": true,
"hasGlasses": true,
"yaw": 0,
"pitch": 0,
"roll": 0,
"landmarks": [{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
},
{"x": 0,
"y": 0
}
]
},
"embedding": {"sdkVersion": "string",
"modelName": "string",
"featureVector": [0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
},
"personId": "string",
"photoId": "string"
}

Response samples

Content type

application/json

{"result": "Success"
}

Reset Password

Allows a matcher admin to reset a matcher user or admin's password. Requires a valid JWT.

Authorizations:

matcher-api-admin-auth

Request Body schema: application/json

username required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"username": "string",
"password": "string"
}

Create Gallery

Allows authorized users to create a facial recognition gallery. Requires a valid JWT.

Authorizations:

matcher-api-user-auth

Request Body schema: application/json

gallery

required

string^((?!xn--)[a-z0-9][a-z0-9-]{1,52}[a-z0-9])$|^...

Responses

Request samples

Payload

Content type

application/json

{"gallery": "string"
}

Response samples

Content type

application/json

{"result": "Success"
}

List Users

Allows a matcher admin to list all matcher and admin users. Requires a valid JWT.

Authorizations:

matcher-api-admin-auth

Responses

Response samples

Content type

application/json

{"admins": [{"username": "string",
"active": true
}
],
"users": [{"username": "string",
"active": true
}
]
}

Activate User

Allows a matcher admin to activate a deactivated matcher user or admin. Requires a valid JWT.

Authorizations:

matcher-api-admin-auth

Request Body schema: application/json

username required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"result": "Success"
}

Create User

Allows a matcher admin to create a new matcher user or admin. Requires a valid JWT.

Authorizations:

matcher-api-admin-auth

Request Body schema: application/json

username required	string
isAdmin	boolean

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"isAdmin": true
}

Response samples

Content type

application/json

{"username": "string",
"password": "string"
}