People

getPerson

get

This method returns the information of a person, given its PGUID.

Path parameters
pguidstringRequired

Global unique ID of the person.

Query parameters
biographicBasebooleanOptional

Determines if the API will try to get biographics from the Biobase Server or not.

Responses
200

OK

application/json
get
GET /gbds/v2/people/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{
  "data": {
    "pguid": "text",
    "lastEnrollTguid": "text",
    "timestamp": 1,
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biometric": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "auxiliaries": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "metadata": [
      "text"
    ],
    "labels": [
      "text"
    ],
    "history": {
      "events": [
        {
          "tguid": "text",
          "timestamp": 1,
          "type": "text",
          "targetTguid": "text"
        }
      ]
    },
    "biographicBaseStatus": "UNAVAILABLE"
  }
}

update

put

This method performs an update operation in GBDS.

Path parameters
pguidstringRequired

Global unique ID of the person.

Body
Responses
201

Enrolled

application/json
put
PUT /gbds/v2/people/{pguid} HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 826

{
  "data": {
    "timestamp": 1,
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biometric": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "auxiliaries": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "metadata": "text",
    "labels": [
      "text"
    ]
  },
  "meta": {
    "timeout": 1,
    "priority": "GOD_PRIORITY",
    "validationType": "SAME_FINGERS",
    "externalIDs": [
      {
        "name": "text",
        "key": "text"
      }
    ],
    "labels": "ACCUMULATE",
    "liveness": true,
    "biographicBase": {
      "autoUpdate": true,
      "sendPguidAsKey": true,
      "sendTguidAsKey": true
    }
  }
}
{
  "data": {
    "status": "ENQUEUED",
    "tguid": "text",
    "biographicBaseStatus": "UNAVAILABLE"
  }
}

deletePerson

delete

This method deletes the information of a person, given its PGUID.

Path parameters
pguidstringRequired

Global unique ID of the person.

Query parameters
prioritystring · enumOptional

Priority of the operation. Default is GOD_PRIORITY.

Possible values:
timeoutintegerOptional

Timeout of the operation. Default is 0.

If the timeout is -1, the operation will be executed synchronously. If the timeout is 0, the operation will be executed asynchronously. If the timeout is >0 (greater than 0), the operation will be executed synchronously after the timeout.

Responses
204

Deleted

*/*
Responseobject
delete
DELETE /gbds/v2/people/{pguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

enroll

post

This method submits a new enrollment operation to GBDS.

Body
Responses
201

Enrolled

application/json
post
POST /gbds/v2/people HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 826

{
  "data": {
    "timestamp": 1,
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biometric": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "auxiliaries": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "metadata": "text",
    "labels": [
      "text"
    ]
  },
  "meta": {
    "timeout": 1,
    "priority": "GOD_PRIORITY",
    "validationType": "SAME_FINGERS",
    "externalIDs": [
      {
        "name": "text",
        "key": "text"
      }
    ],
    "labels": "ACCUMULATE",
    "liveness": true,
    "biographicBase": {
      "autoUpdate": true,
      "sendPguidAsKey": true,
      "sendTguidAsKey": true
    }
  }
}
{
  "data": {
    "status": "ENQUEUED",
    "tguid": "text",
    "biographicBaseStatus": "UNAVAILABLE"
  }
}

listPeople

post

This method returns a list of people who match the given search criteria.

Body
Responses
200

OK

application/json
post
POST /gbds/v2/people/list HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 270

{
  "data": {
    "personFields": [
      "BIOMETRIC"
    ],
    "pguids": [
      "text"
    ],
    "pageIndex": 1,
    "pageSize": 1,
    "restrictions": [
      {
        "type": "BIOGRAPHIC",
        "id": "text",
        "value": "text",
        "exists": true,
        "matchMode": "EXACT"
      }
    ],
    "operator": "AND",
    "includeAnomalies": true,
    "paginationCount": true,
    "biographicBase": true
  }
}
{
  "data": [
    {
      "pguid": "text",
      "lastEnrollTguid": "text",
      "timestamp": 1,
      "keys": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "biographics": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "biometric": [
        {
          "source": "CONSOLIDATED_TEMPLATE",
          "type": "FINGERPRINT",
          "format": "PRIVATE",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1,
            "matcherId": 1,
            "extractorId": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ],
      "auxiliaries": [
        {
          "source": "CONSOLIDATED_TEMPLATE",
          "type": "FINGERPRINT",
          "format": "PRIVATE",
          "properties": {
            "width": 1,
            "height": 1,
            "resolution": 1,
            "ratio": 1,
            "matcherId": 1,
            "extractorId": 1
          },
          "index": 1,
          "content": "text",
          "quality": 1
        }
      ],
      "metadata": [
        "text"
      ],
      "labels": [
        "text"
      ],
      "history": {
        "events": [
          {
            "tguid": "text",
            "timestamp": 1,
            "type": "text",
            "targetTguid": "text"
          }
        ]
      },
      "biographicBaseStatus": "UNAVAILABLE"
    }
  ],
  "pagination": {
    "total": 1,
    "count": 1,
    "pageSize": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

deleteBiometric

delete

This method delete a specific biometric in a person's register, given the person's PGUID and biometric index.

Path parameters
pguidstringRequired

Global unique ID of the person.

biometricIndexinteger · int32Required

Finger index to be excluded.

Responses
200

OK

*/*
Responseobject
delete
DELETE /gbds/v2/people/{pguid}/biometric/{biometricIndex} HTTP/1.1
Host: <ip>:8085
Accept: */*
200

OK

{}

getPguidUsingKeys

get

This method returns the PGUID of a person, given its search keys.

Query parameters
key_idstringRequired

ID of the key to be used to identify the reference person.

key_valuestringRequired

Value of the key to be used to identify the reference person.

Responses
200

OK

application/json
get
GET /gbds/v2/people/pguid?key_id=text&key_value=text HTTP/1.1
Host: <ip>:8085
Accept: */*

{
  "data": "text"
}

disablePeopleTransaction

delete

This method deletes a transaction from a person, given its TGUID and the person's PGUID.

Path parameters
pguidstringRequired

Global unique ID of the person.

tguidstringRequired

Global unique ID of the transaction.

Responses
204

Deleted

*/*
Responseobject
delete
DELETE /gbds/v2/people/{pguid}/transactions/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

{}

trustedEnroll

post

This method performs an enrollment operation without comparing biometrics.

Body
Responses
201

Enrolled

application/json
post
POST /gbds/v2/people/trusted HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 815

{
  "data": {
    "timestamp": 1,
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biometric": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "auxiliaries": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "metadata": "text",
    "labels": [
      "text"
    ]
  },
  "meta": {
    "timeout": 1,
    "priority": "GOD_PRIORITY",
    "active": true,
    "externalIDs": [
      {
        "name": "text",
        "keys": "text"
      }
    ],
    "labelsOperation": "REPLACE",
    "liveness": true,
    "biographicBase": {
      "autoUpdate": true,
      "sendPguidAsKey": true,
      "sendTguidAsKey": true
    }
  }
}
{
  "data": {
    "status": "ENQUEUED",
    "tguid": "text",
    "biographicBaseStatus": "UNAVAILABLE"
  }
}

trustedUpdate

put

This method performs an update operation without comparing biometrics.

Path parameters
pguidstringRequired

Global unique ID of the person.

Body
Responses
201

Enrolled

application/json
put
PUT /gbds/v2/people/{pguid}/trusted HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 815

{
  "data": {
    "timestamp": 1,
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biometric": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "auxiliaries": [
      {
        "source": "CONSOLIDATED_TEMPLATE",
        "type": "FINGERPRINT",
        "format": "PRIVATE",
        "properties": {
          "width": 1,
          "height": 1,
          "resolution": 1,
          "ratio": 1,
          "matcherId": 1,
          "extractorId": 1
        },
        "index": 1,
        "content": "text",
        "quality": 1
      }
    ],
    "metadata": "text",
    "labels": [
      "text"
    ]
  },
  "meta": {
    "timeout": 1,
    "priority": "GOD_PRIORITY",
    "active": true,
    "externalIDs": [
      {
        "name": "text",
        "keys": "text"
      }
    ],
    "labelsOperation": "REPLACE",
    "liveness": true,
    "biographicBase": {
      "autoUpdate": true,
      "sendPguidAsKey": true,
      "sendTguidAsKey": true
    }
  }
}
{
  "data": {
    "status": "ENQUEUED",
    "tguid": "text",
    "biographicBaseStatus": "UNAVAILABLE"
  }
}

trustedAddKeys

post

Adds new keys to a person.

Path parameters
pguidstringRequired

Global unique ID of the person.

Body
Responses
200

OK

application/json
post
POST /gbds/v2/people/{pguid}/trusted/keys HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "data": [
    {
      "id": "text",
      "value": "text"
    }
  ]
}
{
  "data": {
    "pguid": "text",
    "lastEnrollTguid": "text",
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ]
  }
}

updateBiographicsOnBiobaseUsingPGUID

post

This endpoint creates or updates biographics on the Biographic Base Server using BioBase configuration on API. It uses any key provided to find a person/identity on the server. If it does, it updates it with all biographics provided, keeping the existing ones. If it does not find any person/identity with the keys provided, it creates a person/identity on the server with the keys and biographics provided. It calls all servers until one responds with a 2xx http code. If none respond successfully, it returns the last server response call code.

Always send PGUID as key.

Path parameters
pguidstringRequired

Global unique ID of the person.

Body
Responses
201

Identity created on Biobase Server

post
POST /gbds/v2/people/{pguid}/bio-base HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "data": {
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "name",
        "type": "TEXT",
        "value": "John"
      }
    ]
  }
}
No content

updateBiographicsOnBiobaseUsingPGUIDAndTGUID

post

This endpoint creates or updates biographics on the Biographic Base Server using BioBase configuration on API. It uses any key provided to find a person/identity on the server. If it does, it updates it with all biographics provided, keeping the existing ones. If it does not find any person/identity with the keys provided, it creates a person/identity on the server with the keys and biographics provided. It calls all servers until one responds with a 2xx http code. If none respond successfully, it returns the last server response call code.

Always send PGUID and TGUID as keys.

Path parameters
pguidstringRequired

Global unique ID of the person.

tguidstringRequired

Global unique ID of the transaction.

Body
Responses
201

Identity created on Biobase Server

post
POST /gbds/v2/people/{pguid}/bio-base/{tguid} HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "data": {
    "keys": [
      {
        "id": "text",
        "value": "text"
      }
    ],
    "biographics": [
      {
        "id": "name",
        "type": "TEXT",
        "value": "John"
      }
    ]
  }
}
No content