Skip to main content
Documentation Powered by Redocly

by Unico Client Api (1.6.0)

Download OpenAPI specification:Download

IDCloud Tribe: squad-utp-digital-account@unico.io URL: https://developers.unico.io/docs/orquestrador/intro/

by Unico Api used by clients to manage processes.

Client Service

listProcesses

List Orca Processes

query Parameters
processId
string

Specify a process ID to fetch a single process. Optional.

createdAtStartDate
string <date-time>

Start date for the process query range, required in "YYYY-MM-DDThh:mm:ss.SSS" format.

createdAtEndDate
string <date-time>

End date for the process query range, required in "YYYY-MM-DDThh:mm:ss.SSS" format.

maxNumberProcesses
integer <int32>

Maximum number of process records to return, required to control fetch size.

duiValue
string

Specify a CPF number to filter processes by the taxpayer's CPF. Optional.

processStates
Array of strings
Items Enum: "PROCESS_STATE_UNSPECIFIED" "PROCESS_STATE_CREATED" "PROCESS_STATE_FINISHED" "PROCESS_STATE_FAILED" "PROCESS_STATE_CANCELED"

Specify one or more statuses to filter the processes. Optional.

  • PROCESS_STATE_CREATED: The process was created and still accepts new sessions
  • PROCESS_STATE_FINISHED: The process was finished and no longer accepts new sessions
  • PROCESS_STATE_FAILED: deprecated
  • PROCESS_STATE_CANCELED: deprecated
processCapacities
Array of strings
Items Enum: "PROCESS_CAPACITY_UNSPECIFIED" "PROCESS_CAPACITY_IDLIVE" "PROCESS_CAPACITY_IDUNICO" "PROCESS_CAPACITY_IDCHECK" "PROCESS_CAPACITY_IDDOCS" "PROCESS_CAPACITY_IDSIGN" "PROCESS_CAPACITY_IDTOKEN" "PROCESS_CAPACITY_IDTRUST" "PROCESS_CAPACITY_IDSERPRO"

Specify the capacity of the process. Optional.

processResults
Array of strings
Items Enum: "PROCESS_RESULT_UNSPECIFIED" "PROCESS_RESULT_OK" "PROCESS_RESULT_WARNING" "PROCESS_RESULT_ERROR" "PROCESS_RESULT_INVALID_IDENTITY" "PROCESS_RESULT_EXPIRED" "PROCESS_RESULT_REFUSED"

Specify one or more results to filter processes. Optional.

  • PROCESS_RESULT_OK: The process completed successfully
  • PROCESS_RESULT_WARNING: The process completed with some warning(s).
  • PROCESS_RESULT_ERROR: The process finished with errors.
  • PROCESS_RESULT_INVALID_IDENTITY: The process finished with no valid authentication for the user.
  • PROCESS_RESULT_EXPIRED: The process expired by not finishing in a specified time window.
  • PROCESS_RESULT_REFUSED: The process was refused by the user.

Responses

Response samples

Content type
application/json
{
  • "processes": [
    ]
}

createProcess

Create Orca Process

query Parameters
flow
string

Process Flow code. Ex: idcheck, iddocs

callbackUri
string

Callback Uri for event trigger

person.duiType
string
Default: "DUI_TYPE_UNSPECIFIED"
Enum: "DUI_TYPE_UNSPECIFIED" "DUI_TYPE_BR_CPF" "DUI_TYPE_MX_CURP"

Unique Identifier type

person.duiValue
string

Unique Identifier value

person.friendlyName
string

Optional friendly name

person.email
string
person.phone
string
purpose
string

Purpose code for proper GDPR treatment

bioTokenId
string

ProcessId (uuid) to be used in the process creation. Required for idtoken flow.

expiresIn
string

Time in minutes for the process to expire

companyBranchId
string

Branch id of the company

contextualization.locale.ptBr.reason
string
contextualization.locale.enUs.reason
string
contextualization.locale.esMx.reason
string
contextualization.currency
string
contextualization.price
number <float>

Responses

Response samples

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

getProcess

Retrieve Orca Process

path Parameters
processId
required
string

ProcessId (uuid) returned by a previous 'Create Process' request

Responses

Response samples

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

getProcessEvidenceSet

Retrieve process evidence set document.

path Parameters
processId
required
string

ProcessId (uuid)

Responses

Response samples

Content type
application/json
{
  • "fileContents": "string",
  • "contentType": "string"
}

getProcessAuthenticationSelfie

Retrieve process authentication selfie.

path Parameters
processId
required
string

ProcessId (uuid)

query Parameters
raw
boolean

if image is raw or watermarked (default)

Responses

Response samples

Content type
application/json
{
  • "fileContents": "string",
  • "contentType": "string"
}

manageKeysConfig

Manage apikeys.

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "apiKeys": [
    ]
}