Api

ping

get

This method is used to check the API availability.

Responses
200

default response

text/plain
Responsestring
get
GET /gbs-psbio-server/service/ac-api/ping HTTP/1.1
Host: <ip>:8084
Accept: */*
200

default response

pong!

getTransactionResult

get

This method returns the result of a transaction, given its TCN.

Path parameters
tcnstringRequired
Responses
200

default response

application/json
get
GET /gbs-psbio-server/service/ac-api/get-transaction-result/{tcn} HTTP/1.1
Host: <ip>:8084
Accept: */*
200

default response

{
  "status": "OK,",
  "message": "text",
  "tcn": "text"
}

enroll

post

This method submits an enrollment operation to the PSBio

Body
idnstringOptional
protocolstringOptional
capture-dateinteger · int64Optional
capture-responsiblestringOptional
amputated-indexesinteger · int32[]Optional
bandaged-indexesinteger · int32[]Optional
ignore-face-valuationbooleanOptional
Responses
200

default response

application/json
post
POST /gbs-psbio-server/service/ac-api/enroll HTTP/1.1
Host: <ip>:8084
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "idn": "text",
  "biometrics": [
    {
      "index": 1,
      "content": "text",
      "width": 1,
      "height": 1,
      "resolution": 1
    }
  ],
  "protocol": "text",
  "capture-date": 1,
  "capture-responsible": "text",
  "amputated-indexes": [
    1
  ],
  "bandaged-indexes": [
    1
  ],
  "ignore-face-valuation": true
}
200

default response

{
  "status": "OK,",
  "message": "text",
  "tcn": "text"
}

update

post

This method submits an update operation to the PSBio.

Body
idnstringOptional
protocolstringOptional
capture-dateinteger · int64Optional
capture-responsiblestringOptional
amputated-indexesinteger · int32[]Optional
bandaged-indexesinteger · int32[]Optional
ignore-face-valuationbooleanOptional
Responses
200

default response

application/json
post
POST /gbs-psbio-server/service/ac-api/update HTTP/1.1
Host: <ip>:8084
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "idn": "text",
  "biometrics": [
    {
      "index": 1,
      "content": "text",
      "width": 1,
      "height": 1,
      "resolution": 1
    }
  ],
  "protocol": "text",
  "capture-date": 1,
  "capture-responsible": "text",
  "amputated-indexes": [
    1
  ],
  "bandaged-indexes": [
    1
  ],
  "ignore-face-valuation": true
}
200

default response

{
  "status": "OK,",
  "message": "text",
  "tcn": "text"
}

search

post

This method submits a biometric search operation to the PSBio

Body
idnstringOptional
protocolstringOptional
capture-dateinteger · int64Optional
capture-responsiblestringOptional
amputated-indexesinteger · int32[]Optional
bandaged-indexesinteger · int32[]Optional
ignore-face-valuationbooleanOptional
Responses
200

default response

application/json
post
POST /gbs-psbio-server/service/ac-api/search HTTP/1.1
Host: <ip>:8084
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "idn": "text",
  "biometrics": [
    {
      "index": 1,
      "content": "text",
      "width": 1,
      "height": 1,
      "resolution": 1
    }
  ],
  "protocol": "text",
  "capture-date": 1,
  "capture-responsible": "text",
  "amputated-indexes": [
    1
  ],
  "bandaged-indexes": [
    1
  ],
  "ignore-face-valuation": true
}
200

default response

{
  "status": "OK,",
  "message": "text",
  "tcn": "text"
}

consultaIdn

get

This method checks if an IDN is enrolled in the PSBio network. If the IDN is enrolled, it returns the consulted IDN, the indexes of the biometrics associated with the IDN and the name of the PSBIO that owns it. If the IDN is not enrolled, it returns the consulted IDN and an empty list.

Query parameters
idnstringRequired

Unique identifier of the biometric traits owner that will be consulted.

Responses
200

default response

application/json
get
GET /gbs-psbio-server/service/ac-api/idn?idn={idn}?idn=text HTTP/1.1
Host: <ip>:8084
Accept: */*
200

default response

{
  "idn": "string",
  "psbioOwner": "string",
  "indexes": [
    1,
    2,
    3
  ]
}