Pular para o conteúdo principal
Documentation Powered by Redocly

Orca Client Api (1.0)

Download OpenAPI specification:Download

utp | Digital Account: squad-utp-digital-account@unico.io URL: https://docs.unico.io/orca

Orca Api used by clients to manage processes.

OrcaClientService

Orca Client API

Unico Api Docs

OrcaClientService_CreateProcess

Create Orca Process

query Parameters
flow
string

Process Flow code. Ex: auth_docs

callbackUri
string

Callback Uri for event trigger

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

Unique Identifier type

person.duiValue
string

Unique Identifier value

person.friendlyName
string

Optional friendly name

purpose
string

Purpose code for proper GDPR treatment

Responses

Response samples

Content type
application/json
{
  • "id": "3116552c-cde0-4769-838a-1b6a5280c286",
  • "flow": "string",
  • "company": {
    },
  • "callbackUri": "string",
  • "userRedirectUrl": "string",
  • "state": "PROCESS_STATE_UNSPECIFIED",
  • "result": "PROCESS_RESULT_UNSPECIFIED",
  • "resultMessages": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "person": {
    },
  • "documents": [
    ]
}

OrcaClientService_GetProcess

Retrieve Orca Process

path Parameters
id
required
string

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

Responses

Response samples

Content type
application/json
{
  • "id": "3116552c-cde0-4769-838a-1b6a5280c286",
  • "flow": "string",
  • "company": {
    },
  • "callbackUri": "string",
  • "userRedirectUrl": "string",
  • "state": "PROCESS_STATE_UNSPECIFIED",
  • "result": "PROCESS_RESULT_UNSPECIFIED",
  • "resultMessages": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "person": {
    },
  • "documents": [
    ]
}