diff --git a/index.html b/index.html index c9a9f57..51dc69c 100644 --- a/index.html +++ b/index.html @@ -2222,7 +2222,7 @@

Clients

groupIds
Array of strings <uuid>

IDs of the groups in which the search is performed.

Responses

Response Schema: application/json
code
required
integer (FaceSDKResultCode)
Enum: 0 1 2 3 4 … 34 more
Array of objects (MatchImageResult)
elapsedTime
float
object

A free-form object containing person's extended attributes.

+
Array of objects (MatchImageResult)
elapsedTime
number <float>
object

A free-form object containing person's extended attributes.

Array of objects

Request samples

Content type
application/json
{
  • "tag": "string",
  • "images": [
    • {
      • "content": "string",
      • "type": 1
      }
    ],
  • "createPerson": {
    • "name": "string",
    • "metadata": { }
    },
  • "groupIds": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "results": [
    • {
      • "firstIndex": 0,
      • "firstFaceIndex": 0,
      • "first": 1,
      • "secondIndex": 0,
      • "secondFaceIndex": 0,
      • "second": 1,
      • "score": 0,
      • "similarity": 0
      }
    ],
  • "elapsedTime": 1.317137987,
  • "metadata": { },
  • "detections": [
    • {
      • "faces": [
        • {
          • "faceIndex": 0,
          • "landmarks": [
            ],
          • "rotationAngle": 2.1272900104522705,
          • "roi": [
            ],
          • "thumbnail": "string",
          • "crop": "string",
          • "persons": [
            ]
          }
        ],
      • "imageIndex": 0,
      • "status": 0
      }
    ]
}

Detect face, evaluate attributes, assess the portrait quality

header Parameters
X-RequestID
string

Request header label.

@@ -2319,7 +2319,7 @@

Clients

object

Uploaded image.

object (OutputImageParams)

Whether to process the uploaded image according to the indicated settings.

detectAll
boolean (detectAll)
Default: false

Whether to detect all faces in the image. If set to false, only the most central face is detected.

-
threshold
float

The similarity threshold.

+
threshold
number <float>

The similarity threshold.

limit
integer

The maximum number of results to be returned.

Responses

Response Schema: application/json
id
string

Response image ID. The list is sorted by decreasing ID value.

@@ -2338,7 +2338,7 @@

Clients

type
string

Error type.

msg
string

Error message.

Request samples

Content type
application/json
{
  • "tag": "string",
  • "image": {
    • "contentType": "string",
    • "content": "string",
    • "imageUrl": "string",
    • "resizeOptions": {
      • "width": 0,
      • "height": 0,
      • "quality": 100
      }
    },
  • "outputImageParams": {
    • "backgroundColor": [
      • 128,
      • 128,
      • 128
      ],
    • "crop": {
      • "type": 0,
      • "padColor": [
        • 128,
        • 128,
        • 128
        ],
      • "size": [
        • 300,
        • 400
        ],
      • "returnOriginalRect": true
      }
    },
  • "detectAll": false,
  • "threshold": null,
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "contentType": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "path": "string",
  • "url": "string",
  • "metadata": { }
}

Get person image by id

path Parameters
personId
required
string <uuid>

Person ID.

+
http://localhost:41101/api/persons/{personId}/images

Request samples

Content type
application/json
{
  • "tag": "string",
  • "image": {
    • "contentType": "string",
    • "content": "string",
    • "imageUrl": "string",
    • "resizeOptions": {
      • "width": 0,
      • "height": 0,
      • "quality": 100
      }
    },
  • "outputImageParams": {
    • "backgroundColor": [
      • 128,
      • 128,
      • 128
      ],
    • "crop": {
      • "type": 0,
      • "padColor": [
        • 128,
        • 128,
        • 128
        ],
      • "size": [
        • 300,
        • 400
        ],
      • "returnOriginalRect": true
      }
    },
  • "detectAll": false,
  • "threshold": 0,
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "contentType": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "path": "string",
  • "url": "string",
  • "metadata": { }
}

Get person image by id

path Parameters
personId
required
string <uuid>

Person ID.

imageId
required
string

Image ID.

header Parameters
X-RequestID
string

Request header label.

Responses

object

Uploaded image.

object (OutputImageParams)

Whether to process the uploaded image according to the indicated settings.

detectAll
boolean (detectAll)
Default: false

Whether to detect all faces in the image. If set to false, only the most central face is detected.

-
threshold
float

The similarity threshold.

+
threshold
number <float>

The similarity threshold.

limit
integer

The maximum number of results to be returned.

Responses

Response Schema: application/json
code
integer

Search result code.

@@ -2499,7 +2499,7 @@

Clients

object

A free-form object containing person's extended attributes.

Response Schema: application/json
msg
string
Default: "Descriptor already calculated"
statusCode
integer
Default: 400
type
string
Default: "BadParamsException"

Request samples

Content type
application/json
{
  • "createPerson": {
    • "name": "string",
    • "metadata": { }
    },
  • "groupIds": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "tag": "string",
  • "image": {
    • "contentType": "string",
    • "content": "string",
    • "imageUrl": "string",
    • "resizeOptions": {
      • "width": 0,
      • "height": 0,
      • "quality": 100
      }
    },
  • "outputImageParams": {
    • "backgroundColor": [
      • 128,
      • 128,
      • 128
      ],
    • "crop": {
      • "type": 0,
      • "padColor": [
        • 128,
        • 128,
        • 128
        ],
      • "size": [
        • 300,
        • 400
        ],
      • "returnOriginalRect": true
      }
    },
  • "detectAll": false,
  • "threshold": null,
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "persons": [
    • {
      • "name": "string",
      • "metadata": { },
      • "groups": [
        • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "createdAt": "string",
      • "updatedAt": "string",
      • "detection": {
        • "code": 0,
        • "crop": "string",
        • "detectorType": 0,
        • "hash": "string",
        • "idx": 0,
        • "image": "string",
        • "landmarks": [
          • [
            ]
          ],
        • "landmarksType": 2,
        • "msg": "string",
        • "roi": [
          • "x",
          • "y",
          • "width",
          • "height"
          ],
        • "versionSDK": "5.2.245.687"
        },
      • "images": [
        • {
          • "id": "string",
          • "contentType": "string",
          • "createdAt": "string",
          • "updatedAt": "string",
          • "path": "string",
          • "url": "string",
          • "metadata": { },
          • "similarity": 0,
          • "distance": 0
          }
        ]
      }
    ]
}

liveness 2.0

Liveness assessment

query Parameters
transactionId
required
string <uuid>

ID of the current liveness transaction.

+
http://localhost:41101/api/search

Request samples

Content type
application/json
{
  • "createPerson": {
    • "name": "string",
    • "metadata": { }
    },
  • "groupIds": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "tag": "string",
  • "image": {
    • "contentType": "string",
    • "content": "string",
    • "imageUrl": "string",
    • "resizeOptions": {
      • "width": 0,
      • "height": 0,
      • "quality": 100
      }
    },
  • "outputImageParams": {
    • "backgroundColor": [
      • 128,
      • 128,
      • 128
      ],
    • "crop": {
      • "type": 0,
      • "padColor": [
        • 128,
        • 128,
        • 128
        ],
      • "size": [
        • 300,
        • 400
        ],
      • "returnOriginalRect": true
      }
    },
  • "detectAll": false,
  • "threshold": 0,
  • "limit": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "persons": [
    • {
      • "name": "string",
      • "metadata": { },
      • "groups": [
        • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "createdAt": "string",
      • "updatedAt": "string",
      • "detection": {
        • "code": 0,
        • "crop": "string",
        • "detectorType": 0,
        • "hash": "string",
        • "idx": 0,
        • "image": "string",
        • "landmarks": [
          • [
            ]
          ],
        • "landmarksType": 2,
        • "msg": "string",
        • "roi": [
          • "x",
          • "y",
          • "width",
          • "height"
          ],
        • "versionSDK": "5.2.245.687"
        },
      • "images": [
        • {
          • "id": "string",
          • "contentType": "string",
          • "createdAt": "string",
          • "updatedAt": "string",
          • "path": "string",
          • "url": "string",
          • "metadata": { },
          • "similarity": 0,
          • "distance": 0
          }
        ]
      }
    ]
}

liveness 2.0

Liveness assessment

query Parameters
transactionId
required
string <uuid>

ID of the current liveness transaction.

Responses

Response Schema: application/json
code
integer

Result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/

status
integer
Default: null

Whether the liveness detection is confirmed (0) or not (1).

tag
string

Session identificator.

@@ -2515,7 +2515,7 @@

Clients

Response Schema: application/json
property name*
additional property
any

Response samples

Content type
application/json
{ }