PSBio API Documentation (5.6.7)

Download OpenAPI specification:Download

api

ping

This method is used to check the API availability.

Responses

Response samples

200

Content type

text/plain

pong!

getTransactionResult

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

path Parameters

tcn

required

string

Responses

Response samples

200

Content type

application/json

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

enroll

This method submits an enrollment operation to the PSBio

Request Body schema: application/json

idn	string
	Array of objects (Biometrics)
protocol	string
capture-date	integer <int64>
capture-responsible	string
amputated-indexes	Array of integers <int32> [ items <int32 > ]
bandaged-indexes	Array of integers <int32> [ items <int32 > ]
ignore-face-valuation	boolean

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

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

update

This method submits an update operation to the PSBio.

Request Body schema: application/json

idn	string
	Array of objects (Biometrics)
protocol	string
capture-date	integer <int64>
capture-responsible	string
amputated-indexes	Array of integers <int32> [ items <int32 > ]
bandaged-indexes	Array of integers <int32> [ items <int32 > ]
ignore-face-valuation	boolean

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

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

search

This method submits a biometric search operation to the PSBio

Request Body schema: application/json

idn	string
	Array of objects (Biometrics)
protocol	string
capture-date	integer <int64>
capture-responsible	string
amputated-indexes	Array of integers <int32> [ items <int32 > ]
bandaged-indexes	Array of integers <int32> [ items <int32 > ]
ignore-face-valuation	boolean

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

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

consultaIdn

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

idn

required

string

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

Responses

Response samples

200

Content type

application/json

Example

Success

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

exceptions

gbds-ping

This method is used to check the API availability.

Responses

listExceptions

This method returns a list of exceptions that match a given search criteria.

query Parameters

status	Array of strings unique Items Enum: "ANALYSIS" "DIFFERENT_FINGERS" "SAME_FINGERS" "INCORRECT_ENROLL" "RECOLLECT" "MERGE_TRANSACTIONS" "APPROVE" "REJECT" "ERROR"
startDate	integer <int64>
endDate	integer <int64>
user	string
keys	Array of strings unique
biographics	Array of strings unique
labels required	Array of strings unique
exceptionFields	Array of strings Items Enum: "NO_FIELDS" "ALL_FIELDS"

Responses

Response samples

200

Content type

application/json

{"data": [{"enrollPguid": "string",
"enrollTguid": "string",
"transactionTimestamp": 0,
"match": {"matchedPersonPguid": "string",
"matchedPersonTguid": "string",
"biometricMatches": [{"score": 0,
"queryIndex": 0,
"referenceIndex": 0,
"minutia": [{"queryIndex": 0,
"referenceIndex": 0
}
]
}
]
},
"assignedUser": "string",
"exceptionAnalysis": {"status": "ANALYSIS",
"exceptionTimestamp": 0,
"user": "string",
"comments": "string"
},
"transactionType": "ENROLL"
}
],
"pagination": {"total": 0,
"count": 0,
"pageSize": 0,
"currentPage": 0,
"totalPages": 0
},
"httpResponse": {"httpCode": 0,
"body": "string"
}
}

listByTransaction

This method returns the exception list from a given exception.

path Parameters

tguid

required

string

Responses

Response samples

200

Content type

application/json

{"data": [{"enrollPguid": "string",
"enrollTguid": "string",
"transactionTimestamp": 0,
"match": {"matchedPersonPguid": "string",
"matchedPersonTguid": "string",
"biometricMatches": [{"score": 0,
"queryIndex": 0,
"referenceIndex": 0,
"minutia": [{"queryIndex": 0,
"referenceIndex": 0
}
]
}
]
},
"assignedUser": "string",
"exceptionAnalysis": {"status": "ANALYSIS",
"exceptionTimestamp": 0,
"user": "string",
"comments": "string"
},
"transactionType": "ENROLL"
}
],
"pagination": {"total": 0,
"count": 0,
"pageSize": 0,
"currentPage": 0,
"totalPages": 0
},
"httpResponse": {"httpCode": 0,
"body": "string"
}
}

assignException

This method assigns an exception to a given user.

path Parameters

tguid required	string
pguid required	string
user required	string

Responses

treat

This method provides the treatment for a given exception.

Request Body schema: application/json

	object (ExceptionTreatment)
	object (Meta)
	object (Subject)
	object (ValidatedExceptionTreatment)

Responses

Request samples

Payload

Content type

application/json

{"data": {"enrollTguid": "string",
"exceptionPguid": "string",
"exceptionAnalysis": {"status": "ANALYSIS",
"exceptionTimestamp": 0,
"user": "string",
"comments": "string"
},
"referenceIndexes": [0
]
},
"meta": {"timeout": 0,
"discardReference": true
},
"subject": {"name": "string",
"roles": [{ }
],
"permissions": [{ }
]
},
"validatedExceptionTreatment": {"enrollTguid": "string",
"exceptionPguid": "string",
"exceptionAnalysis": {"status": "ANALYSIS",
"exceptionTimestamp": 0,
"user": "string",
"comments": "string"
},
"referenceIndexes": [0
]
}
}

gbds-getPerson

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

path Parameters

pguid

required

string

query Parameters

personFields	Array of strings Items Enum: "BIOMETRIC" "AUXILIARIES" "KEYS" "BIOGRAPHICS" "LABELS" "METADATA" "BASIC_FIELDS" "NO_FIELDS" "ALL_FIELDS"
biometricFields	Array of strings unique Items Enum: "INDEX" "ALL_FIELDS"

Responses

getTransaction

This method returns the data of a transaction, given its TGUID.

path Parameters

tguid

required

string

query Parameters

enrollFields	Array of strings Items Enum: "BASIC_FIELDS" "EXCEPTIONS" "QUALITY" "PERSON" "EXCEPTION_ISSUES" "EXTERNAL_IDS" "ALL_FIELDS" "NO_FIELDS"
personFields	Array of strings Items Enum: "BIOMETRIC" "AUXILIARIES" "KEYS" "BIOGRAPHICS" "LABELS" "METADATA" "BASIC_FIELDS" "NO_FIELDS" "ALL_FIELDS"

Responses

Response samples

200

Content type

application/json

{"data": {"tguid": "string",
"pguid": "string",
"status": "ENQUEUED",
"timestamp": 0,
"progress": 0,
"candidates": [{"matchedPersonPguid": "string",
"matchedPersonTguid": "string",
"biometricMatches": [{"score": 0,
"queryIndex": 0,
"referenceIndex": 0,
"minutia": [{"queryIndex": 0,
"referenceIndex": 0
}
]
}
]
}
],
"person": {"pguid": "string",
"lastEnrollTguid": "string",
"timestamp": 0,
"keys": [{"id": "string",
"value": "string"
}
],
"biographics": [{"id": "string",
"value": "string"
}
],
"biometric": [{"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "RAW",
"properties": {"width": 0,
"height": 0,
"resolution": 0,
"ratio": 0
},
"index": 0,
"content": "string",
"quality": 0
}
],
"metadata": "string",
"labels": ["string"
],
"history": {"events": [{"tguid": "string",
"timestamp": 0,
"type": "string"
}
]
},
"auxiliaryImages": [{"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "RAW",
"properties": {"width": 0,
"height": 0,
"resolution": 0,
"ratio": 0
},
"index": 0,
"content": "string",
"quality": 0
}
],
"ebts": [{"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "RAW",
"properties": {"width": 0,
"height": 0,
"resolution": 0,
"ratio": 0
},
"index": 0,
"content": "string",
"quality": 0
}
]
},
"qualityAnalysis": {"status": "PENDING",
"assignedUser": "string",
"user": "string",
"comments": "string",
"timestamp": 0,
"duplicationIssues": [{"indexes": [0
],
"nextDuplicate": [0
]
}
],
"qualityIssues": [{"index": 0,
"quality": 0
}
],
"sequenceControlIssues": [{"index": 0,
"matches": [{"index": 0,
"score": 0
}
]
}
],
"sequenceControlParityIssue": {"missingIndexes": [0
]
}
},
"failReason": "string",
"extractionIssues": [{"index": 0,
"message": "string"
}
],
"externalIds": [{"name": "string",
"key": "string"
}
],
"isCurrentTransaction": true
},
"httpResponse": {"httpCode": 0,
"body": "string"
}
}

listTransactions

This method returns a list of enrollment and update transactions that match the search criteria.

query Parameters

enrollStatus	string Enum: "ENQUEUED" "PROCESSING" "ENROLLED" "EXCEPTION" "FAILED" "PENDING"
qualityStatus	string Enum: "PENDING" "APPROVED" "REJECTED" "OK" "ERROR" "PENDING_DUPLICITIES"
startDate	integer <int64>
endDate	integer <int64>
pageSize	integer <int32>
pageIndex	integer <int32>
enrollFields	Array of strings Items Enum: "BASIC_FIELDS" "EXCEPTIONS" "QUALITY" "PERSON" "EXCEPTION_ISSUES" "EXTERNAL_IDS" "ALL_FIELDS" "NO_FIELDS"
personFields	Array of strings Items Enum: "BIOMETRIC" "AUXILIARIES" "KEYS" "BIOGRAPHICS" "LABELS" "METADATA" "BASIC_FIELDS" "NO_FIELDS" "ALL_FIELDS"

Responses

Response samples

200

Content type

application/json

{"data": [{"tguid": "string",
"pguid": "string",
"status": "ENQUEUED",
"timestamp": 0,
"progress": 0,
"candidates": [{"matchedPersonPguid": "string",
"matchedPersonTguid": "string",
"biometricMatches": [{"score": 0,
"queryIndex": 0,
"referenceIndex": 0,
"minutia": [{"queryIndex": 0,
"referenceIndex": 0
}
]
}
]
}
],
"person": {"pguid": "string",
"lastEnrollTguid": "string",
"timestamp": 0,
"keys": [{"id": "string",
"value": "string"
}
],
"biographics": [{"id": "string",
"value": "string"
}
],
"biometric": [{"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "RAW",
"properties": {"width": 0,
"height": 0,
"resolution": 0,
"ratio": 0
},
"index": 0,
"content": "string",
"quality": 0
}
],
"metadata": "string",
"labels": ["string"
],
"history": {"events": [{"tguid": "string",
"timestamp": 0,
"type": "string"
}
]
},
"auxiliaryImages": [{"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "RAW",
"properties": {"width": 0,
"height": 0,
"resolution": 0,
"ratio": 0
},
"index": 0,
"content": "string",
"quality": 0
}
],
"ebts": [{"source": "ORIGINAL",
"type": "FINGERPRINT",
"format": "RAW",
"properties": {"width": 0,
"height": 0,
"resolution": 0,
"ratio": 0
},
"index": 0,
"content": "string",
"quality": 0
}
]
},
"qualityAnalysis": {"status": "PENDING",
"assignedUser": "string",
"user": "string",
"comments": "string",
"timestamp": 0,
"duplicationIssues": [{"indexes": [0
],
"nextDuplicate": [0
]
}
],
"qualityIssues": [{"index": 0,
"quality": 0
}
],
"sequenceControlIssues": [{"index": 0,
"matches": [{"index": 0,
"score": 0
}
]
}
],
"sequenceControlParityIssue": {"missingIndexes": [0
]
}
},
"failReason": "string",
"extractionIssues": [{"index": 0,
"message": "string"
}
],
"externalIds": [{"name": "string",
"key": "string"
}
],
"isCurrentTransaction": true
}
],
"pagination": {"total": 0,
"count": 0,
"pageSize": 0,
"currentPage": 0,
"totalPages": 0
},
"meta": { },
"httpResponse": {"httpCode": 0,
"body": "string"
}
}