API docs by Redocly

SPID Server API Specification (4.2.12)

Download OpenAPI specification:Download

Client Update

getVersion

This method returns the latest version available for SPID Client in the server

Responses

getFile

This method performs the automatic update for the SPID Server application.

query Parameters
os
string
Default: "windows"

Responses

Deletion

deletePerson

This method deletes a person from the database, given its CPF.

path Parameters
cpf
required
string

Responses

deletePSBioPerson

This method deletes a person from the PSBio database, given its CPF and MOT (reason for deletion, error or fraud).

path Parameters
cpf
required
string
mot
required
string
Enum: "E" "F"

Responses

getDeleteResult

This method returns the status of a delete transaction, given its TGUID (ID).

path Parameters
id
required
string

Responses

Enrollment

enroll

This method submits the enrollment of a person (client) to the server.

Request Body schema: application/json
required
object (UserTransaction)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

getEnrollResult

This method returns the result of an enrollment transaction, given its TGUID (ID).

path Parameters
id
required
string

Responses

getPerson

This method returns the data of a person enrolled into the database, given its search keys.

path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "approvement": {
    },
  • "auxiliaries": [
    ],
  • "biographics": [
    ],
  • "biometrics": [
    ],
  • "enroll-status": "ENQUEUED",
  • "keys": [
    ],
  • "labels": [
    ],
  • "metadata": "string",
  • "person-guid": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "transaction-guid": "string"
}

Report Generation

generateReport

This method generates a report for a transaction, given its TGUID.

path Parameters
tguid
required
string

Responses

Operator

getOperator

This method returns the information of an operator, given its search keys.

path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "document": "string",
  • "biometrics": [
    ],
  • "status": "VERIFIED",
  • "tguid": "string"
}

deleteOperator

This method deletes an operator from the database, given its search keys.

path Parameters
key
required
string

Responses

operatorList

This method returns the list of valid operators into the database.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

enrollOperator

This method submits an operator enrollment to the server.

Request Body schema: application/json
required
object (OperatorEnrollPayload)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

operatorInsert

Request Body schema: application/json
required

operator Insert Request

object (OperatorInsertPayload)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Remote

createRemoteVerify

This method creates a remote capture request for Face and/or Fingerprints verification.

Request Body schema: application/json
required
object (TransactionIdentifier)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "tguid": "string",
  • "dynamicLink": "string"
}

createRemoteEnroll

This method creates a remote capture request for Face and/or Fingerprints enrollment.

Request Body schema: application/json
required
object (TransactionIdentifier)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "tguid": "string",
  • "dynamicLink": "string"
}

createRemoteVerify

Request Body schema: application/json
required

remoteCaptureRequest

object (TransactionIdentifier)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "tguid": "string",
  • "dynamicLink": "string"
}

getBiometrics

path Parameters
tguid
required
string

tguid

Responses

Response samples

Content type
application/json
{
  • "index": 0,
  • "content": "string",
  • "width": 0,
  • "height": 0,
  • "resolution": 0
}

finishRemoteCapture

path Parameters
tguid
required
string

tguid

Request Body schema: application/json
required

remoteCaptureApproval

approval
boolean

Responses

Request samples

Content type
application/json
{
  • "approval": true
}

notificationRemoteCapture

Request Body schema: application/json
required

remoteCaptureNotificationRequest

guid
string

Responses

Request samples

Content type
application/json
{
  • "guid": "string"
}

faceDetect

This method receives a base64 image and detects whether it has a single face or not. If a single face is detected, creates a transaction and returns its TGUID, else returns an error.

Request Body schema: application/json
required
userId
string
operatorId
string
image
string

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "operatorId": "string",
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Search

verify

This method performs a biometric verification into the database.

Request Body schema: application/json
required
object (UserTransaction)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "message": "string",
  • "status": "OK"
}

getSearchResult

This method returns the result of a verify operation, given its TGUID.

path Parameters
tguid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "message": "string",
  • "status": "OK"
}

Status

getStatus

This method returns the current status of the SPID Server services.

Responses

Token

updateToken

This method updates the token used to communicate to an external base

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Transaction

GetTransactionGuid

path Parameters
guid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "OK",
  • "type": "ENROLL",
  • "transaction": {
    }
}

GetTransactionData

path Parameters
tguid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "operatorId": "string",
  • "type": "string",
  • "status": "string",
  • "timestamp": 0,
  • "psbioTcn": "string",
  • "biometrics": [
    ]
}

GetPersonTransactionData

path Parameters
cpf
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "operatorId": "string",
  • "type": "string",
  • "status": "string",
  • "timestamp": 0,
  • "psbioTcn": "string",
  • "biometrics": [
    ]
}

Redirect

RedirectEnroll

Redirects an enroll transaction with status ENROLL_REJECTED to a SEARCH transaction with a new guid.

path Parameters
guid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "SEARCH_PENDING"
}

Deprecated

deprecatedLatestVersion

This method returns the current version of the SPID Server application.

Responses

Response samples

Content type
application/json
"string"

deprecatedAuthenticate

This method authenticates the session and generates a Session GUID.

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
"string"

deprecatedDeletePerson

This method deletes a person from the database, given its CPF.

path Parameters
sessionGuid
required
string
cpf
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedUpdateVersion

This method performs the automatic update for the SPID Server application.

Responses

deprecatedSearch

This method performs a biometric search in the database.

Request Body schema: application/json
required
operator
string
timestamp
integer <int64>
Array of objects (Key)
Array of objects (ContentData)

Responses

Request samples

Content type
application/json
{
  • "operator": "string",
  • "timestamp": 0,
  • "keys": [
    ],
  • "biometrics": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedGetOperator

This method returns the information of an operator, given its search keys.

path Parameters
sessionGuid
required
string
key
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedGetEnrollResult

This method returnts the result of an enrollment transaction, given its TGUID.

path Parameters
sessionGuid
required
string
transactionGuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedOperatorList

This method returns a list the valid operators into the database.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

deprecatedEnrollOperator

This method submits an operator enrollment to the server.

Request Body schema: application/json
required
metadata
Array of strings <byte>
timeout
integer <int32>
labels
Array of strings
filters
Array of strings
priority
string
Enum: "LOWEST_PRIORITY" "LOWER_PRIORITY" "LOW_PRIORITY" "DEFAULT_PRIORITY" "HIGH_PRIORITY" "HIGHER_PRIORITY" "HIGHEST_PRIORITY"
session-guid
string
person-guid
string
Array of objects (Key)
Array of objects (BiographicData)
Array of objects (ContentData)
Array of objects (ContentData)
matching-index
string
Enum: "SAME_FINGERS" "ALL_FINGERS" "CROSSED_WINDOW_TWEEZERS"
force-face-search
boolean

Responses

Request samples

Content type
application/json
{
  • "metadata": [
    ],
  • "timeout": 0,
  • "labels": [
    ],
  • "filters": [
    ],
  • "priority": "LOWEST_PRIORITY",
  • "session-guid": "string",
  • "person-guid": "string",
  • "keys": [
    ],
  • "biographics": [
    ],
  • "biometrics": [
    ],
  • "auxiliaries": [
    ],
  • "matching-index": "SAME_FINGERS",
  • "force-face-search": true
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedGetPerson

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

path Parameters
sessionGuid
required
string
key
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedOperatorInsert

This method inserts the data of a new operator into the server (it then needs to perform the biometric enrollment).

path Parameters
document
required
string
status
required
string
Enum: "VERIFIED" "GOD_MODE" "PENDING" "EXCEPTION" "ENQUEUED" "DELETED"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

deprecatedGetSearchResult

This method returns the result of a search operation, given its TGUID.

path Parameters
sessionGuid
required
string
transactionGuid
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedPing

This method is intended for checking the SPID Server availability.

Responses

Response samples

Content type
application/json
"string"

deprecatedGetOperatorStatus

This method returns the status of an operator, given its search keys.

path Parameters
sessionGuid
required
string
key
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedIdnSearch

This method returns the status of a given IDN into the PSBio

query Parameters
idn
required
string

Responses

Response samples

Content type
application/json
"string"

deprecatedEnrollClient

This method submits a client enrollment to the server.

Request Body schema: application/json
required
metadata
Array of strings <byte>
timeout
integer <int32>
labels
Array of strings
filters
Array of strings
priority
string
Enum: "LOWEST_PRIORITY" "LOWER_PRIORITY" "LOW_PRIORITY" "DEFAULT_PRIORITY" "HIGH_PRIORITY" "HIGHER_PRIORITY" "HIGHEST_PRIORITY"
operator
string
session-guid
string
person-guid
string
Array of objects (Key)
Array of objects (BiographicData)
Array of objects (ContentData)
Array of objects (ContentData)
matching-index
string
Enum: "SAME_FINGERS" "ALL_FINGERS" "CROSSED_WINDOW_TWEEZERS"
force-face-search
boolean

Responses

Request samples

Content type
application/json
{
  • "metadata": [
    ],
  • "timeout": 0,
  • "labels": [
    ],
  • "filters": [
    ],
  • "priority": "LOWEST_PRIORITY",
  • "operator": "string",
  • "session-guid": "string",
  • "person-guid": "string",
  • "keys": [
    ],
  • "biographics": [
    ],
  • "biometrics": [
    ],
  • "auxiliaries": [
    ],
  • "matching-index": "SAME_FINGERS",
  • "force-face-search": true
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedCloseSession

This method closes the current session.

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "candidates": [
    ],
  • "persons": [
    ],
  • "person": {
    },
  • "transactions": [
    ],
  • "progress": 0,
  • "count": 0,
  • "session-guid": "string",
  • "transaction-guid": "string",
  • "person-guid": "string",
  • "enroll-transactions": [
    ],
  • "anomalies-status": "ANALYSIS"
}

deprecatedCheckStatus

This method returns the current status of the SPID Server services.

Responses

Response samples

Content type
application/json
"string"

deprecatedCreateRemoteCaptureEnrollUsingPOST

query Parameters
required
object (RemoteCaptureRequest)

Responses

deprecatedCreateRemoteCaptureUsingPOST_1

query Parameters
required
object (RemoteCaptureRequest)

Responses