Skip to main content
Documentation Powered by Redocly

ByClient - API (v1)

Download OpenAPI specification:Download

Processes

CreateProcess

Authorizations:
(AuthorizationApiKey)
Request Body schema:
required
object (CreateProcessSubject)
onlySelfie
boolean
useCase
string or null <= 50 characters
processId
string or null <uuid>
subsidiaryId
string or null <uuid>
imageBase64
required
string non-empty

Responses

Request samples

Content type
{
  • "subject": {
    },
  • "onlySelfie": true,
  • "useCase": "string",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "subsidiaryId": "03cda6e8-cd9e-46b1-bc32-fe32f24ce3cb",
  • "imageBase64": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get process previously created.

Meaning of some value of fields at response:

processStatus

  • 1: Waiting for async processing
  • 2: In analysis with operations
  • 3: Finished process
  • 4: Cancelled process
  • 5: Process with error

unicoId.result

  • yes: Faces match de document
  • inconclusive

trust.result (deprecated)

  • no: Do not trust at Face and document set
  • inconclusive

identityFraudsters.result

  • yes: Person already committed identity fraud
  • inconclusive

faceWithOtherID.result

  • yes: Person already use another person's document
  • inconclusive
Feature not available for Brazil.

liveness

  • 0: Inconclusive
  • 1: Live
  • 2: Not live

faceMatchStatus

  • 1: Approved
  • 2: Reproved
Authorizations:
(AuthorizationApiKey)
path Parameters
id
required
string

Process ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": 1,
  • "unicoId": {
    },
  • "trust": {
    },
  • "identityFraudsters": {
    },
  • "faceWithOtherId": {
    },
  • "government": {
    },
  • "liveness": 0,
  • "faceMatch": 0,
  • "hasBiometry": true,
  • "OCRCode": 0,
  • "score": 0
}

Get process previously created.

Meaning of some value of fields at response:

processStatus

  • 1: Waiting for async processing
  • 2: In analysis with operations
  • 3: Finished process
  • 4: Cancelled process
  • 5: Process with error

unicoId.result

  • yes: Faces match de document
  • inconclusive

trust.result (deprecated)

  • no: Do not trust at Face and document set
  • inconclusive

identityFraudsters.result

  • yes: Person already committed identity fraud
  • inconclusive

faceWithOtherID.result

  • yes: Person already use another person's document
  • inconclusive
Feature not available for Brazil.

liveness

  • 0: Inconclusive
  • 1: Live
  • 2: Not live

faceMatchStatus

  • 1: Approved
  • 2: Reproved

processAdditionalInfo

  • Additional Information to process
Authorizations:
(AuthorizationApiKey)
path Parameters
id
required
string

Process ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": 1,
  • "unicoId": {
    },
  • "trust": {
    },
  • "identityFraudsters": {
    },
  • "faceWithOtherId": {
    },
  • "government": {
    },
  • "liveness": 0,
  • "faceMatch": 0,
  • "hasBiometry": true,
  • "OCRCode": 0,
  • "score": 0
}