Endpoints
Face recognition is a biometric technology that identifies or verifies individuals based on their facial features. It's commonly used in security systems, access controls and surveillance
Face Recognition Scanner
Create a new face recognition scan.
Request Body
Name
Type
Description
```
{
"channel": "WEB",
"compare_result": "Same person",
"compare_similarity": 0.8381412625312805,
"created": "2024-05-01T12:12:06.090098",
"face1": {
"eye_dist": 50.08992004394531,
"face_luminance": 159.13522338867188,
"face_occlusion": 0.0877809002995491,
"face_quality": 1.0,
"landmark_68": [
{
"x": 159.9080047607422,
"y": 213.405517578125
},
{
"x": 163.94924926757812,
"y": 228.4378662109375
},
{
"x": 171.15225219726562,
"y": 243.11358642578125
},
{
"x": 181.77725219726562,
"y": 256.544921875
},
{
"x": 195.8515625,
"y": 266.1007080078125
},
{
"x": 211.98077392578125,
"y": 271.6827087402344
},
{
"x": 229.05120849609375,
"y": 274.84027099609375
},
{
"x": 245.83673095703125,
"y": 275.61602783203125
},
{
"x": 259.72064208984375,
"y": 271.3165588378906
},
{
"x": 268.67425537109375,
"y": 260.332275390625
},
{
"x": 271.884765625,
"y": 245.8240966796875
},
{
"x": 274.4581298828125,
"y": 232.471435546875
},
{
"x": 275.5724792480469,
"y": 219.0947265625
},
{
"x": 274.10711669921875,
"y": 205.41802978515625
},
{
"x": 271.076416015625,
"y": 191.30987548828125
},
{
"x": 264.81884765625,
"y": 178.06741333007812
},
{
"x": 256.9525451660156,
"y": 166.44915771484375
},
{
"x": 175.1534423828125,
"y": 190.7509765625
},
{
"x": 181.491943359375,
"y": 182.3602294921875
},
{
"x": 191.215576171875,
"y": 175.28207397460938
},
{
"x": 202.9010009765625,
"y": 171.42446899414062
},
{
"x": 213.8670654296875,
"y": 170.13275146484375
},
{
"x": 235.52020263671875,
"y": 162.0626220703125
},
{
"x": 239.69973754882812,
"y": 155.11544799804688
},
{
"x": 244.6612548828125,
"y": 149.91329956054688
},
{
"x": 250.08074951171875,
"y": 147.75003051757812
},
{
"x": 254.84735107421875,
"y": 149.4954071044922
},
{
"x": 231.076171875,
"y": 178.96234130859375
},
{
"x": 236.67193603515625,
"y": 187.56268310546875
},
{
"x": 242.02716064453125,
"y": 195.97296142578125
},
{
"x": 247.61532592773438,
"y": 204.79806518554688
},
{
"x": 234.56613159179688,
"y": 219.84585571289062
},
{
"x": 241.2802734375,
"y": 219.01885986328125
},
{
"x": 247.62582397460938,
"y": 217.494384765625
},
{
"x": 251.72274780273438,
"y": 213.5943603515625
},
{
"x": 254.37051391601562,
"y": 209.3935546875
},
{
"x": 191.90859985351562,
"y": 197.73263549804688
},
{
"x": 197.94256591796875,
"y": 190.91177368164062
},
{
"x": 205.27032470703125,
"y": 187.62716674804688
},
{
"x": 213.09860229492188,
"y": 189.678466796875
},
{
"x": 207.4571533203125,
"y": 194.22698974609375
},
{
"x": 200.24008178710938,
"y": 197.358154296875
},
{
"x": 238.74777221679688,
"y": 177.06716918945312
},
{
"x": 242.7979736328125,
"y": 169.46600341796875
},
{
"x": 248.874755859375,
"y": 166.07647705078125
},
{
"x": 254.26614379882812,
"y": 167.1254119873047
},
{
"x": 251.10159301757812,
"y": 172.17669677734375
},
{
"x": 245.31982421875,
"y": 175.55648803710938
},
{
"x": 224.44500732421875,
"y": 242.3819580078125
},
{
"x": 233.7891845703125,
"y": 234.32577514648438
},
{
"x": 243.41314697265625,
"y": 227.60211181640625
},
{
"x": 249.00689697265625,
"y": 226.45147705078125
},
{
"x": 252.9534912109375,
"y": 222.81063842773438
},
{
"x": 258.89422607421875,
"y": 221.70123291015625
},
{
"x": 263.21966552734375,
"y": 223.005615234375
},
{
"x": 262.7288818359375,
"y": 233.503662109375
},
{
"x": 259.8438720703125,
"y": 241.506591796875
},
{
"x": 255.01010131835938,
"y": 245.53070068359375
},
{
"x": 248.71875,
"y": 247.99700927734375
},
{
"x": 237.37692260742188,
"y": 247.317138671875
},
{
"x": 227.3553466796875,
"y": 241.72137451171875
},
{
"x": 244.70175170898438,
"y": 233.4580078125
},
{
"x": 250.30654907226562,
"y": 231.24984741210938
},
{
"x": 254.71661376953125,
"y": 228.03250122070312
},
{
"x": 261.49969482421875,
"y": 224.748046875
},
{
"x": 256.5648193359375,
"y": 233.78350830078125
},
{
"x": 252.0416259765625,
"y": 237.36831665039062
},
{
"x": 246.2628173828125,
"y": 239.7921142578125
}
],
"left_eye_closed": 0.00011981386342085898,
"mouth_opened": 0.6982099413871765,
"pitch": 3.550708532333374,
"right_eye_closed": 0.16304536163806915,
"roll": -23.1104736328125,
"x1": 158,
"x2": 287,
"y1": 114,
"y2": 279,
"yaw": -25.781755447387695
},
"face2": {
"eye_dist": 68.00735473632812,
"face_luminance": 88.98311614990234,
"face_occlusion": 0.009843501262366772,
"face_quality": 1.0,
"landmark_68": [
{
"x": 222.7457275390625,
"y": 191.49185180664062
},
{
"x": 220.11575317382812,
"y": 213.11688232421875
},
{
"x": 218.78466796875,
"y": 238.70602416992188
},
{
"x": 219.12030029296875,
"y": 263.62286376953125
},
{
"x": 223.34933471679688,
"y": 286.94195556640625
},
{
"x": 233.71237182617188,
"y": 307.81671142578125
},
{
"x": 248.89303588867188,
"y": 326.3203125
},
{
"x": 267.73199462890625,
"y": 342.28009033203125
},
{
"x": 288.332763671875,
"y": 351.3136901855469
},
{
"x": 307.5712585449219,
"y": 351.09307861328125
},
{
"x": 320.7541198730469,
"y": 339.97625732421875
},
{
"x": 331.7563171386719,
"y": 327.3253173828125
},
{
"x": 343.55743408203125,
"y": 312.58489990234375
},
{
"x": 354.7043762207031,
"y": 296.1376953125
},
{
"x": 365.9080810546875,
"y": 279.39788818359375
},
{
"x": 373.8034362792969,
"y": 261.42681884765625
},
{
"x": 379.218505859375,
"y": 243.94882202148438
},
{
"x": 275.2679748535156,
"y": 189.3505859375
},
{
"x": 292.1291809082031,
"y": 187.13604736328125
},
{
"x": 307.6185607910156,
"y": 190.3924560546875
},
{
"x": 320.9264831542969,
"y": 198.91342163085938
},
{
"x": 332.6530456542969,
"y": 209.39263916015625
},
{
"x": 362.69342041015625,
"y": 222.17333984375
},
{
"x": 371.4140625,
"y": 220.3612060546875
},
{
"x": 379.9426574707031,
"y": 219.550048828125
},
{
"x": 387.85833740234375,
"y": 220.280517578125
},
{
"x": 392.11468505859375,
"y": 225.52566528320312
},
{
"x": 343.6534423828125,
"y": 234.159423828125
},
{
"x": 341.72357177734375,
"y": 249.69305419921875
},
{
"x": 340.04290771484375,
"y": 264.4344482421875
},
{
"x": 339.0794677734375,
"y": 279.216796875
},
{
"x": 311.779052734375,
"y": 281.47161865234375
},
{
"x": 319.3206787109375,
"y": 286.53326416015625
},
{
"x": 327.2457275390625,
"y": 291.2067565917969
},
{
"x": 334.2529296875,
"y": 291.37103271484375
},
{
"x": 339.579833984375,
"y": 289.8460998535156
},
{
"x": 286.3609313964844,
"y": 211.73583984375
},
{
"x": 298.70880126953125,
"y": 210.7984619140625
},
{
"x": 309.196533203125,
"y": 214.76507568359375
},
{
"x": 315.139404296875,
"y": 225.45065307617188
},
{
"x": 305.478271484375,
"y": 224.8543701171875
},
{
"x": 294.6009826660156,
"y": 220.62005615234375
},
{
"x": 351.6282653808594,
"y": 238.22097778320312
},
{
"x": 361.59326171875,
"y": 234.40020751953125
},
{
"x": 370.98004150390625,
"y": 236.57904052734375
},
{
"x": 375.5724792480469,
"y": 242.786865234375
},
{
"x": 368.7994384765625,
"y": 246.19683837890625
},
{
"x": 359.5838317871094,
"y": 243.814697265625
},
{
"x": 281.41534423828125,
"y": 299.6136474609375
},
{
"x": 298.7375793457031,
"y": 300.49603271484375
},
{
"x": 314.224365234375,
"y": 301.81121826171875
},
{
"x": 319.6688232421875,
"y": 305.68182373046875
},
{
"x": 325.13970947265625,
"y": 305.711181640625
},
{
"x": 329.58514404296875,
"y": 310.7529296875
},
{
"x": 329.77642822265625,
"y": 315.493896484375
},
{
"x": 324.1186218261719,
"y": 321.86138916015625
},
{
"x": 318.0751037597656,
"y": 325.3734130859375
},
{
"x": 311.1572265625,
"y": 324.32037353515625
},
{
"x": 303.19085693359375,
"y": 321.2728576660156
},
{
"x": 292.2985534667969,
"y": 312.7744140625
},
{
"x": 285.25518798828125,
"y": 301.2769775390625
},
{
"x": 309.8360595703125,
"y": 308.8609924316406
},
{
"x": 316.6443786621094,
"y": 311.61993408203125
},
{
"x": 322.47015380859375,
"y": 312.8897705078125
},
{
"x": 327.18621826171875,
"y": 315.20416259765625
},
{
"x": 321.1614990234375,
"y": 314.1095886230469
},
{
"x": 315.0880126953125,
"y": 313.2396240234375
},
{
"x": 308.24383544921875,
"y": 310.4541931152344
}
],
"left_eye_closed": 0.0013316706754267216,
"mouth_opened": 0.563499927520752,
"pitch": 21.480295181274414,
"right_eye_closed": 1.1952434988415916e-06,
"roll": 22.514259338378906,
"x1": 205,
"x2": 404,
"y1": 124,
"y2": 362,
"yaw": -19.924283981323242
},
"id": "f2d051aa-045d-4f87-822f-ad694464614c",
"reference": "0002"
}
```get
Get by id
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : OpenID Connect scope for add user roles to the access token
Path parameters
idstring · uuidRequired
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
404
Not Found
*/*
get
/v1/face-recognition/{id}put
Update entity
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : OpenID Connect scope for add user roles to the access token
Path parameters
idstring · uuidRequired
Body
Ocr Face Recognition Scan model
idstring · uuidOptional
companyIdstring · uuidOptional
Company Id
createdDatestring · date-timeOptional
Created Date
updatedDatestring · date-timeOptional
Updated Date
createdByIdstring · uuidOptional
Created By
updatedByIdstring · uuidOptional
Updated By
elapsedTimenumber · doubleOptional
Elapsed Time of extraction in seconds
compareResultstringOptional
compareSimilaritynumber · doubleOptional
salesChannelstringOptional
Responses
200
OK
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
404
Not Found
*/*
put
/v1/face-recognition/{id}get
Get results paginated
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : OpenID Connect scope for add user roles to the access token
Query parameters
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
404
Not Found
*/*
get
/v1/face-recognitionLast updated