Get face matchmaker

Get face matchmaker.

POST /api/faceRecognition/matchmaker/getFaceMatchmaker

Get face matchmaker

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/faceRecognition/matchmaker/getFaceMatchmaker \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "faceId": "face_12345"
}
'

200

{
  "faceMatchmaker": {
    "createdOn": "2024-01-01T00:00:00Z",
    "id": "face_12345",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "personUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uploaded": true
  }
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for retrieving a face matchmaker by face ID.

faceId · string | null

Face ID to retrieve the matchmaker for

Example:

"face_12345"

Response

200 - application/json

OK

Response object containing a face matchmaker.

faceMatchmaker · object

External face matchmaker object containing face recognition matchmaker data and metadata.

Show child attributes