Skip to main content
POST
/
api
/
faceRecognition
/
matchmaker
/
uploadFaceMatchmakers
Upload face matchmakers
curl --request POST \
  --url https://api2.rhombussystems.com/api/faceRecognition/matchmaker/uploadFaceMatchmakers \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --form 'bodyParts={
  "contentDisposition": {
    "attachment": true,
    "charset": {
      "registered": true
    },
    "creationDate": "2023-11-07T05:31:56Z",
    "filename": "<string>",
    "formData": true,
    "inline": true,
    "modificationDate": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "readDate": "2023-11-07T05:31:56Z",
    "size": 123,
    "type": "<string>"
  },
  "entity": {},
  "headers": {
    "empty": true
  },
  "mediaType": {
    "charset": {
      "registered": true
    },
    "concrete": true,
    "parameters": {},
    "qualityValue": 123,
    "subtype": "<string>",
    "subtypeSuffix": "<string>",
    "type": "<string>",
    "wildcardSubtype": true,
    "wildcardType": true
  },
  "messageBodyWorkers": {},
  "parameterizedHeaders": {
    "empty": true
  },
  "parent": {
    "bodyParts": "<array>",
    "contentDisposition": {
      "attachment": true,
      "charset": {
        "registered": true
      },
      "creationDate": "2023-11-07T05:31:56Z",
      "filename": "<string>",
      "formData": true,
      "inline": true,
      "modificationDate": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "readDate": "2023-11-07T05:31:56Z",
      "size": 123,
      "type": "<string>"
    },
    "entity": {},
    "headers": {
      "empty": true
    },
    "mediaType": {
      "charset": {
        "registered": true
      },
      "concrete": true,
      "parameters": {},
      "qualityValue": 123,
      "subtype": "<string>",
      "subtypeSuffix": "<string>",
      "type": "<string>",
      "wildcardSubtype": true,
      "wildcardType": true
    },
    "messageBodyWorkers": {},
    "parameterizedHeaders": {
      "empty": true
    },
    "providers": {}
  },
  "providers": {}
}' \
  --form 'contentDisposition={
  "attachment": true,
  "charset": {
    "registered": true
  },
  "creationDate": "2023-11-07T05:31:56Z",
  "filename": "<string>",
  "formData": true,
  "inline": true,
  "modificationDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "readDate": "2023-11-07T05:31:56Z",
  "size": 123,
  "type": "<string>"
}' \
  --form 'entity={}' \
  --form 'fields={}' \
  --form 'headers={
  "empty": true
}' \
  --form 'mediaType={
  "charset": {
    "registered": true
  },
  "concrete": true,
  "parameters": {},
  "qualityValue": 123,
  "subtype": "<string>",
  "subtypeSuffix": "<string>",
  "type": "<string>",
  "wildcardSubtype": true,
  "wildcardType": true
}' \
  --form 'messageBodyWorkers={}' \
  --form 'parameterizedHeaders={
  "empty": true
}' \
  --form 'parent={
  "bodyParts": "<array>",
  "contentDisposition": {
    "attachment": true,
    "charset": {
      "registered": true
    },
    "creationDate": "2023-11-07T05:31:56Z",
    "filename": "<string>",
    "formData": true,
    "inline": true,
    "modificationDate": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "readDate": "2023-11-07T05:31:56Z",
    "size": 123,
    "type": "<string>"
  },
  "entity": {},
  "headers": {
    "empty": true
  },
  "mediaType": {
    "charset": {
      "registered": true
    },
    "concrete": true,
    "parameters": {},
    "qualityValue": 123,
    "subtype": "<string>",
    "subtypeSuffix": "<string>",
    "type": "<string>",
    "wildcardSubtype": true,
    "wildcardType": true
  },
  "messageBodyWorkers": {},
  "parameterizedHeaders": {
    "empty": true
  },
  "providers": {}
}' \
  --form 'providers={}'
{
  "fileUploadResults": [
    {
      "fileName": "<string>",
      "message": "<string>",
      "success": true
    }
  ],
  "transactionId": "txn_12345"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
transaction
string | null

Unique transaction id to track the face matchmakers upload progress. If not specified, the system will generate it.

​
createPersonIfNotFound
boolean | null

If a person is not found and createPersonIfNotFound is set to true, a new person is created

Body

multipart/form-data

Multipart form-data containing a .jpg or .png file. Maximum file size: 5MB.

​
bodyParts
(object | null)[] | null
​
contentDisposition
object
​
entity
object
​
fields
object
​
headers
object
​
mediaType
object
​
messageBodyWorkers
object
​
parameterizedHeaders
object
​
parent
object
​
providers
object

Response

200 - application/json

OK

Response object for uploading face matchmakers with transaction tracking and upload results.

​
fileUploadResults
object[] | null

List of file upload results for each uploaded face matchmaker

​
transactionId
string | null

Transaction ID to track face matchmakers upload progress

Example:

"txn_12345"

Last modified on May 7, 2026