Skip to main content
POST
/
api
/
faceRecognition
/
matchmaker
/
getFaceMatchmaker
Get face matchmaker
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"
}
'
{
  "faceMatchmaker": {
    "createdOn": "2024-01-01T00:00:00Z",
    "id": "face_12345",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "personUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uploaded": true
  }
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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.