Enrollment
This method submits the enrollment of a person (client) to the server.
Body
Responses
200
OK
*/*
201
Created
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
415
Unsupported Media Type
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
503
Service Unavailable
*/*
post
POST /gbs-spid-server/people HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 209
{
"data": {
"biometrics": [
{
"index": 1,
"content": "text",
"width": 1,
"height": 1,
"resolution": 1
}
],
"missingBiometrics": [
{
"index": 1,
"type": "AMPUTATED",
"reason": "text"
}
],
"userId": "text",
"operatorId": "text",
"timestamp": 1
}
}{
"id": "text",
"message": "text",
"status": "OK"
}This method returns the result of an enrollment transaction, given its TGUID (ID).
Path parameters
idstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
415
Unsupported Media Type
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
503
Service Unavailable
*/*
get
GET /gbs-spid-server/people/transactions/{id} HTTP/1.1
Host: <ip>:8082
Accept: */*
{
"id": "text",
"message": "text",
"status": "OK"
}This method returns the data of a person enrolled into the database, given its search keys.
Path parameters
keystringRequired
Responses
200
OK
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
415
Unsupported Media Type
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
503
Service Unavailable
*/*
get
GET /gbs-spid-server/people/{key} HTTP/1.1
Host: <ip>:8082
Accept: */*
{
"approvement": {
"comments": "text",
"status": "PENDING",
"timestamp": "2025-08-23T21:25:13.637Z",
"user": "text"
},
"auxiliaries": [
{
"index": 1,
"content": "text",
"properties": {
"description": "text",
"quality": 1,
"index": "NONE",
"location": "NONE",
"anomaly": "NONE",
"metadata": [
"Ynl0ZXM="
],
"capture-date": "2025-08-23T21:25:13.637Z",
"capture-type": "FLAT",
"template-properties": {
"resolution": 1
},
"image-properties": {
"width": 1,
"height": 1,
"resolution": 1,
"ratio": 1
},
"audio-properties": {
"codec": "PCM",
"channels": 1,
"sample-size": 1,
"sample-rate": 1,
"bit-rate": 1
},
"video-properties": {
"audio-codec": "PCM",
"video-codec": "X265",
"audio-bit-rate": 1,
"video-bit-rate": 1,
"total-bit-rate": 1,
"frame-width": 1,
"frame-height": 1,
"frame-rate": 1
},
"fingerprint-properties": {
"type": "MAIN",
"nfiq": 1,
"contrast": 1,
"direction": "LEFT_TO_RIGHT",
"reversions": 1,
"slips": 1,
"frames": 1,
"latent": true,
"dirty-start": true,
"dirty-latter": true
},
"face-properties": {
"icao": true,
"glasses": true,
"shoulder": true,
"smiling": true,
"mouth": {
"x": 1,
"y": 1
},
"busy-background": true,
"saturated-picture": true,
"blurred-picture": true,
"crop-out-of-picture": true,
"skin-color": true,
"face-position": true,
"face-right": true,
"face-left": true,
"face-up": true,
"face-down": true,
"heavy-glasses": true,
"shoulder-left": true,
"shoulder-right": true,
"eyes-obstruction": true,
"looking-down": true,
"looking-up": true,
"looking-right": true,
"looking-left": true,
"too-open-eyes": true,
"too-closed-eyes": true,
"red-eyes": true,
"open-mouth": true,
"showing-teeth": true,
"left-eye": {
"x": 1,
"y": 1
},
"right-eye": {
"x": 1,
"y": 1
},
"recomended-brightness": 1,
"recomended-contrast": 1,
"number-of-faces": 1
},
"signature-properties": {
"notSignable": true
}
},
"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "ASCII"
}
],
"biographics": [
{
"id": "text",
"value": "text"
}
],
"biometrics": [
{
"index": 1,
"content": "text",
"properties": {
"description": "text",
"quality": 1,
"index": "NONE",
"location": "NONE",
"anomaly": "NONE",
"metadata": [
"Ynl0ZXM="
],
"capture-date": "2025-08-23T21:25:13.637Z",
"capture-type": "FLAT",
"template-properties": {
"resolution": 1
},
"image-properties": {
"width": 1,
"height": 1,
"resolution": 1,
"ratio": 1
},
"audio-properties": {
"codec": "PCM",
"channels": 1,
"sample-size": 1,
"sample-rate": 1,
"bit-rate": 1
},
"video-properties": {
"audio-codec": "PCM",
"video-codec": "X265",
"audio-bit-rate": 1,
"video-bit-rate": 1,
"total-bit-rate": 1,
"frame-width": 1,
"frame-height": 1,
"frame-rate": 1
},
"fingerprint-properties": {
"type": "MAIN",
"nfiq": 1,
"contrast": 1,
"direction": "LEFT_TO_RIGHT",
"reversions": 1,
"slips": 1,
"frames": 1,
"latent": true,
"dirty-start": true,
"dirty-latter": true
},
"face-properties": {
"icao": true,
"glasses": true,
"shoulder": true,
"smiling": true,
"mouth": {
"x": 1,
"y": 1
},
"busy-background": true,
"saturated-picture": true,
"blurred-picture": true,
"crop-out-of-picture": true,
"skin-color": true,
"face-position": true,
"face-right": true,
"face-left": true,
"face-up": true,
"face-down": true,
"heavy-glasses": true,
"shoulder-left": true,
"shoulder-right": true,
"eyes-obstruction": true,
"looking-down": true,
"looking-up": true,
"looking-right": true,
"looking-left": true,
"too-open-eyes": true,
"too-closed-eyes": true,
"red-eyes": true,
"open-mouth": true,
"showing-teeth": true,
"left-eye": {
"x": 1,
"y": 1
},
"right-eye": {
"x": 1,
"y": 1
},
"recomended-brightness": 1,
"recomended-contrast": 1,
"number-of-faces": 1
},
"signature-properties": {
"notSignable": true
}
},
"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "ASCII"
}
],
"enroll-status": "ENQUEUED",
"keys": [
{
"id": "text",
"value": "text"
}
],
"labels": [
"text"
],
"metadata": "Ynl0ZXM=",
"person-guid": "text",
"timestamp": "2025-08-23T21:25:13.637Z",
"transaction-guid": "text"
}