Transaction

GetTransactionGuid

get

Path parameters

guidstringRequired

Responses

200

OK

application/json

idstringOptional

statusstring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

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/gbs-spid-server/transaction/{guid}

HTTPcURLJavaScriptPython

GET /gbs-spid-server/transaction/{guid} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "id": "text",
  "status": "OK",
  "type": "ENROLL",
  "transaction": {
    "Biometrics": [
      {
        "index": 1
      }
    ],
    "MissingBiometrics": [
      {
        "index": 1,
        "type": "AMPUTATED",
        "reason": "text"
      }
    ]
  }
}

GetTransactionData

get

Path parameters

tguidstringRequired

Responses

200

OK

application/json

idstringOptional

userIdstringOptional

operatorIdstringOptional

typestringOptional

statusstringOptional

timestampinteger · int64Optional

psbioTcnstringOptional

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/gbs-spid-server/transaction/biometrics/{tguid}

HTTPcURLJavaScriptPython

GET /gbs-spid-server/transaction/biometrics/{tguid} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "id": "text",
  "userId": "text",
  "operatorId": "text",
  "type": "text",
  "status": "text",
  "timestamp": 1,
  "psbioTcn": "text",
  "biometrics": [
    {
      "index": 1,
      "content": "text",
      "width": 1,
      "height": 1,
      "resolution": 1
    }
  ]
}

GetPersonTransactionData

get

Path parameters

cpfstringRequired

Responses

200

OK

application/json

idstringOptional

userIdstringOptional

operatorIdstringOptional

typestringOptional

statusstringOptional

timestampinteger · int64Optional

psbioTcnstringOptional

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/gbs-spid-server/transaction/people/{cpf}

HTTPcURLJavaScriptPython

GET /gbs-spid-server/transaction/people/{cpf} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "id": "text",
  "userId": "text",
  "operatorId": "text",
  "type": "text",
  "status": "text",
  "timestamp": 1,
  "psbioTcn": "text",
  "biometrics": [
    {
      "index": 1,
      "content": "text",
      "width": 1,
      "height": 1,
      "resolution": 1
    }
  ]
}