Profiles

countSearchResults

post

Return the number of profiles found with defined criteria

Header parameters
session-guidstringOptional
Body
namestringOptional
valuestringOptional
Responses
200

successful operation

application/json
post
POST /gbs-intelligence-server/service/profile/list/count HTTP/1.1
Host: localhost:8083
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "value": "text"
}
200

successful operation

{
  "status": "OK",
  "code": 1,
  "count": 1
}

search

post

List the profiles found with the defined criteria

Query parameters
firstinteger · int32Optional
sizeinteger · int32Optional
Header parameters
session-guidstringOptional
Body
namestringOptional
valuestringOptional
Responses
200

successful operation

application/json
post
POST /gbs-intelligence-server/service/profile/list HTTP/1.1
Host: localhost:8083
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "value": "text"
}
200

successful operation

{
  "status": "OK",
  "code": 1,
  "profiles": [
    {
      "pguid": "text",
      "tguid": "text",
      "insertionDate": "2025-08-23T21:20:32.068Z",
      "transactionDate": "2025-08-23T21:20:32.068Z",
      "gbdsStatus": "NONE",
      "history": [
        {
          "tguid": "text",
          "timestamp": "2025-08-23T21:20:32.068Z",
          "type": "ENROLL"
        }
      ],
      "currentTransaction": true,
      "startDate": "2025-08-23T21:20:32.068Z",
      "stopDate": [
        "2025-08-23T21:20:32.068Z"
      ],
      "restartDate": [
        "2025-08-23T21:20:32.068Z"
      ],
      "fingerprints": [
        {
          "index": "NONE",
          "type": "SEQUENCE_CONTROL",
          "typeIndexKey": "text",
          "image": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "height": 1,
          "width": 1,
          "template": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "format": "UNKNOWN",
            "minutiae": [
              {
                "sequence": 1,
                "type": "MINUTIA_BIFURCATION",
                "origin": "ORIGINAL",
                "quality": 1,
                "x": 1,
                "y": 1,
                "angle": 1,
                "angle2": 1,
                "angle3": 1,
                "manual": true,
                "original": true
              }
            ],
            "quality": 1,
            "logDescription": "text"
          },
          "captureType": "NONE",
          "anomaly": "NONE",
          "date": "2025-08-23T21:20:32.068Z",
          "nfiq": 1,
          "contrast": 1,
          "captured": true,
          "extracted": true,
          "marca": "text",
          "modelo": "text",
          "serial": "text",
          "wsqBuffer": [
            "Ynl0ZXM="
          ],
          "imageFormat": "RAW",
          "imageBuffer": [
            "Ynl0ZXM="
          ],
          "templateBuffer": [
            "Ynl0ZXM="
          ],
          "quality": 1,
          "resolution": 1
        }
      ],
      "palms": [
        {
          "index": "NONE",
          "image": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "height": 1,
          "width": 1,
          "template": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "format": "UNKNOWN",
            "minutiae": [
              {
                "sequence": 1,
                "type": "MINUTIA_BIFURCATION",
                "origin": "ORIGINAL",
                "quality": 1,
                "x": 1,
                "y": 1,
                "angle": 1,
                "angle2": 1,
                "angle3": 1,
                "manual": true,
                "original": true
              }
            ],
            "quality": 1,
            "logDescription": "text"
          },
          "captureType": "NONE",
          "anomaly": "NONE",
          "quality": 1,
          "date": "2025-08-23T21:20:32.068Z",
          "converted": true,
          "captured": true,
          "wsqBuffer": [
            "Ynl0ZXM="
          ],
          "imageFormat": "RAW",
          "imageBuffer": [
            "Ynl0ZXM="
          ],
          "templateBuffer": [
            "Ynl0ZXM="
          ],
          "resolution": 1
        }
      ],
      "bodyImages": [
        {
          "index": 1,
          "location": "FACE",
          "type": "FRONTAL",
          "description": "text",
          "image": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "icaoImage": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "template": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "format": "UNKNOWN",
            "minutiae": [
              {
                "sequence": 1,
                "type": "MINUTIA_BIFURCATION",
                "origin": "ORIGINAL",
                "quality": 1,
                "x": 1,
                "y": 1,
                "angle": 1,
                "angle2": 1,
                "angle3": 1,
                "manual": true,
                "original": true
              }
            ],
            "quality": 1,
            "logDescription": "text"
          },
          "processed": true,
          "date": "2025-08-23T21:20:32.068Z",
          "quality": 1,
          "icao": true,
          "faceLeftEye": {
            "x": 1,
            "y": 1
          },
          "faceRightEye": {
            "x": 1,
            "y": 1
          },
          "faceMouth": {
            "x": 1,
            "y": 1
          },
          "icaoLeftEye": {
            "x": 1,
            "y": 1
          },
          "icaoRightEye": {
            "x": 1,
            "y": 1
          },
          "icaoMouth": {
            "x": 1,
            "y": 1
          },
          "marca": "text",
          "modelo": "text",
          "serial": "text",
          "imageFormat": "RAW",
          "imageBuffer": [
            "Ynl0ZXM="
          ],
          "templateBuffer": [
            "Ynl0ZXM="
          ],
          "icaoImageBuffer": [
            "Ynl0ZXM="
          ]
        }
      ],
      "signature": {
        "index": 1,
        "date": "2025-08-23T21:20:32.068Z",
        "image": {
          "buffer": [
            "Ynl0ZXM="
          ],
          "originalFormat": "RAW",
          "toFormat": "RAW",
          "resolution": 1
        },
        "notSignable": true,
        "marca": "text",
        "modelo": "text",
        "serial": "text",
        "imageFormat": "RAW",
        "imageBuffer": [
          "Ynl0ZXM="
        ]
      },
      "labels": [
        "text"
      ],
      "fields": [
        {
          "name": "text",
          "descriptionEnUs": "text",
          "descriptionPtBr": "text",
          "descriptionEsEs": "text",
          "descriptionDrAf": "text",
          "descriptionArIq": "text",
          "required": true,
          "type": "string",
          "kind": "KEY",
          "ebtsField": "text",
          "values": "text",
          "dateMask": "text",
          "value": "text",
          "visible": true,
          "key": "text",
          "valueAsDate": "2025-08-23T21:20:32.068Z",
          "subLabel": "text"
        }
      ],
      "externalIDName": "text",
      "externalIDValue": "text"
    }
  ]
}

getProfile

get

Get profile by person pguid

Path parameters
pguidstringRequired
Query parameters
fieldsstring · enumOptionalPossible values:
image-formatstring · enumOptionalPossible values:
Header parameters
session-guidstringOptional
Responses
200

Ok

application/json
get
GET /gbs-intelligence-server/service/profile/person/{pguid} HTTP/1.1
Host: localhost:8083
Accept: */*
{
  "status": "OK",
  "code": 1,
  "profiles": [
    {
      "pguid": "text",
      "tguid": "text",
      "insertionDate": "2025-08-23T21:20:32.068Z",
      "transactionDate": "2025-08-23T21:20:32.068Z",
      "gbdsStatus": "NONE",
      "history": [
        {
          "tguid": "text",
          "timestamp": "2025-08-23T21:20:32.068Z",
          "type": "ENROLL"
        }
      ],
      "currentTransaction": true,
      "startDate": "2025-08-23T21:20:32.068Z",
      "stopDate": [
        "2025-08-23T21:20:32.068Z"
      ],
      "restartDate": [
        "2025-08-23T21:20:32.068Z"
      ],
      "fingerprints": [
        {
          "index": "NONE",
          "type": "SEQUENCE_CONTROL",
          "typeIndexKey": "text",
          "image": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "height": 1,
          "width": 1,
          "template": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "format": "UNKNOWN",
            "minutiae": [
              {
                "sequence": 1,
                "type": "MINUTIA_BIFURCATION",
                "origin": "ORIGINAL",
                "quality": 1,
                "x": 1,
                "y": 1,
                "angle": 1,
                "angle2": 1,
                "angle3": 1,
                "manual": true,
                "original": true
              }
            ],
            "quality": 1,
            "logDescription": "text"
          },
          "captureType": "NONE",
          "anomaly": "NONE",
          "date": "2025-08-23T21:20:32.068Z",
          "nfiq": 1,
          "contrast": 1,
          "captured": true,
          "extracted": true,
          "marca": "text",
          "modelo": "text",
          "serial": "text",
          "wsqBuffer": [
            "Ynl0ZXM="
          ],
          "imageFormat": "RAW",
          "imageBuffer": [
            "Ynl0ZXM="
          ],
          "templateBuffer": [
            "Ynl0ZXM="
          ],
          "quality": 1,
          "resolution": 1
        }
      ],
      "palms": [
        {
          "index": "NONE",
          "image": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "height": 1,
          "width": 1,
          "template": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "format": "UNKNOWN",
            "minutiae": [
              {
                "sequence": 1,
                "type": "MINUTIA_BIFURCATION",
                "origin": "ORIGINAL",
                "quality": 1,
                "x": 1,
                "y": 1,
                "angle": 1,
                "angle2": 1,
                "angle3": 1,
                "manual": true,
                "original": true
              }
            ],
            "quality": 1,
            "logDescription": "text"
          },
          "captureType": "NONE",
          "anomaly": "NONE",
          "quality": 1,
          "date": "2025-08-23T21:20:32.068Z",
          "converted": true,
          "captured": true,
          "wsqBuffer": [
            "Ynl0ZXM="
          ],
          "imageFormat": "RAW",
          "imageBuffer": [
            "Ynl0ZXM="
          ],
          "templateBuffer": [
            "Ynl0ZXM="
          ],
          "resolution": 1
        }
      ],
      "bodyImages": [
        {
          "index": 1,
          "location": "FACE",
          "type": "FRONTAL",
          "description": "text",
          "image": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "icaoImage": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "originalFormat": "RAW",
            "toFormat": "RAW",
            "resolution": 1
          },
          "template": {
            "buffer": [
              "Ynl0ZXM="
            ],
            "format": "UNKNOWN",
            "minutiae": [
              {
                "sequence": 1,
                "type": "MINUTIA_BIFURCATION",
                "origin": "ORIGINAL",
                "quality": 1,
                "x": 1,
                "y": 1,
                "angle": 1,
                "angle2": 1,
                "angle3": 1,
                "manual": true,
                "original": true
              }
            ],
            "quality": 1,
            "logDescription": "text"
          },
          "processed": true,
          "date": "2025-08-23T21:20:32.068Z",
          "quality": 1,
          "icao": true,
          "faceLeftEye": {
            "x": 1,
            "y": 1
          },
          "faceRightEye": {
            "x": 1,
            "y": 1
          },
          "faceMouth": {
            "x": 1,
            "y": 1
          },
          "icaoLeftEye": {
            "x": 1,
            "y": 1
          },
          "icaoRightEye": {
            "x": 1,
            "y": 1
          },
          "icaoMouth": {
            "x": 1,
            "y": 1
          },
          "marca": "text",
          "modelo": "text",
          "serial": "text",
          "imageFormat": "RAW",
          "imageBuffer": [
            "Ynl0ZXM="
          ],
          "templateBuffer": [
            "Ynl0ZXM="
          ],
          "icaoImageBuffer": [
            "Ynl0ZXM="
          ]
        }
      ],
      "signature": {
        "index": 1,
        "date": "2025-08-23T21:20:32.068Z",
        "image": {
          "buffer": [
            "Ynl0ZXM="
          ],
          "originalFormat": "RAW",
          "toFormat": "RAW",
          "resolution": 1
        },
        "notSignable": true,
        "marca": "text",
        "modelo": "text",
        "serial": "text",
        "imageFormat": "RAW",
        "imageBuffer": [
          "Ynl0ZXM="
        ]
      },
      "labels": [
        "text"
      ],
      "fields": [
        {
          "name": "text",
          "descriptionEnUs": "text",
          "descriptionPtBr": "text",
          "descriptionEsEs": "text",
          "descriptionDrAf": "text",
          "descriptionArIq": "text",
          "required": true,
          "type": "string",
          "kind": "KEY",
          "ebtsField": "text",
          "values": "text",
          "dateMask": "text",
          "value": "text",
          "visible": true,
          "key": "text",
          "valueAsDate": "2025-08-23T21:20:32.068Z",
          "subLabel": "text"
        }
      ],
      "externalIDName": "text",
      "externalIDValue": "text"
    }
  ]
}