Pular para o conteúdo principal
Documentation Powered by Redocly

AcessoService v3 (5.0.0.51)

Download OpenAPI specification:Download

Processes

Métodos para gerenciamento de processos de biometria.

CreateProcess

Cria um novo processo de biometria.

Authorizations:
(AuthorizationAPIKEY)
Request Body schema: application/json
required
object (Subject)
onlySelfie
required
boolean

Quando definido como verdadeiro, indica que o processo contém apenas a imagem biométrica e pode ser concluído. Quando definido como falso, indica que o processo tem 60 minutos para ser concluído. O status do processo é definido como 1 até que o método ExecuteProcess seja processado. Após 60 minutos, se o processo não for concluído, ele é automaticamente cancelado.

webHookUrl
string <= 300 characters

Indica a URL do endpoint onde o status é retornado. É necessária uma configuração de webhook preexistente.

webHookSecret
string <= 200 characters

Indica o token de acesso do endpoint de retorno.

imagebase64
required
string

Imagem em base64 (png, jpg, jpeg).

Responses

Request samples

Content type
application/json
{
  • "subject": {
    },
  • "onlySelfie": true,
  • "webHookUrl": "status.webhook.com",
  • "webHookSecret": "fo9graB5ids9",
  • "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111"
}

DocumentInsert

Anexa um documento no processo de biometria.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string
Request Body schema: application/json
type
required
string

Indica o enumerável do tipo de documento a ser anexado.

imagebase64
required
string

Imagem em base64 (png, jpg, jpeg). Também suporta o Json Web Token (.jwt) capturado por meio do Unico SDK.

Responses

Request samples

Content type
application/json
{
  • "type": "2",
  • "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111",
  • "Typed": "2",
  • "Document": {
    }
}

ExecuteProcess

Finaliza o processo aberto

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111"
}

GetProcess

Retorna as informações do processo

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "HasBiometry": true,
  • "Id": "11111111-1111-1111-1111-111111111111",
  • "Liveness": 0,
  • "Score": 95,
  • "Status": 3,
  • "OCRCode": 0,
  • "FaceMatch": 0
}

GetDocuments

Retorna informações sobre o resultado da análise documental de um processo específico. A informação fica disponível por 8 horas após a inserção do documento.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111",
  • "Documents": [
    ]
}

CancelProcess

Cancela um processo que ainda não foi para a fila de processamento.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111",
  • "Status": 4
}

Messages

Métodos para gerenciamento do fluxo de mensagens (SMS).

CreateMessage

Cria um novo processo de mensagem.

Authorizations:
(AuthorizationAPIKEY)
Request Body schema: application/json
required
object (Subject)
required
Array of objects (Index)
template
required
string

Indica o nome do template criado no portal.

send
required
boolean

Indica se a mensagem é enviada ao usuário.

enableQRCode
boolean

Indica se o QR Code está habilitado. Se true, um QR Code é gerado e uma URL é retornada na resposta.

Responses

Request samples

Content type
application/json
{
  • "subject": {
    },
  • "indexes": [
    ],
  • "template": "assinatura",
  • "send": false,
  • "enableQRCode": true
}

Response samples

DocumentMessageInsert

Insere uma proposta no fluxo de mensagem.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string
Request Body schema: application/json
type
required
string

Indica o enumerável da proposta. Os valores possíveis são 300, 301, 302, 303.

required
object (Signature)
imagebase64
required
string

Proposta em base64 (pdf).

Responses

Request samples

Content type
application/json
{
  • "type": "300",
  • "signature": {
    },
  • "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111"
}

ResumeMessageInsert

Insere um resumo no fluxo de mensagem.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string
Request Body schema: application/json
required
object (Resumes)
description
required
string

Descrição do resumo

html
required
string

HTML do resumo

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111"
}

ExecuteMessage

Finaliza um processo de mensagem.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111"
}

GetMessage

Retorna informações sobre a mensagem. A informação fica disponível por 8 horas após a inserção do documento.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "Documents": [
    ],
  • "HasBiometry": true,
  • "Id": "11111111-1111-1111-1111-111111111111",
  • "Liveness": 0,
  • "Status": 7,
  • "Score": 10,
  • "OCRCode": 0,
  • "FaceMatch": 0,
  • "CurrentStep": 99
}

GetSentMessage

Retorna as informações sobre as mensagens enviadas do processo informado.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
processoId
required
string

Responses

Response samples

Content type
application/json
{
  • "Id": "11111111-1111-1111-1111-111111111111",
  • "MessageList": [
    ]
}

Subjects

Métodos para gerenciamento de pessoas cadastradas.

GetSubject

Retorna o cliente com o cpf informado.

Authorizations:
(AuthorizationAPIKEY)
path Parameters
code
required
number

Responses

Response samples

Content type
application/json
{
  • "Code": "12345678910",
  • "Gender": "M",
  • "HasBiometry": true,
  • "Name": "Bob"
}

Documents

Métodos para gerenciamento de documentos.

OCRCode

Procura no documento informado um determinado CPF.

Authorizations:
(AuthorizationAPIKEY)
Request Body schema: application/json
code
required
string

Indica o CPF a ser procurado.

Base64Documento
required
string

Imagem em base64 do documento (png, jpg, jpeg).

Responses

Request samples

Content type
application/json
{
  • "code": "12345678910",
  • "Base64Documento": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Response samples

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

OCR

Extração de dados de documentos como: CNH (Aberta, frente, verso ou digital), RG (Frente ou Verso) e CRM (Frente ou verso).

Authorizations:
(AuthorizationAPIKEY)
Request Body schema: application/json
type
required
string

Indica o tipo do documento.

base64
required
string

Imagem em base64 do documento (png, jpg, jpeg).

Responses

Request samples

Content type
application/json
{
  • "type": 4,
  • "base64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Response samples

Content type
application/json
{
  • "BirthDate": "01/01/2000",
  • "PlaceOfBirth": "São Paulo",
  • "Category": "AB",
  • "ExpeditionCity": "São Paulo",
  • "ExpeditionState": "SP",
  • "ExpeditionDate": "01/01/2000",
  • "ExpirationDate": "01/01/2000",
  • "FatherName": "João",
  • "MotherName": "Maria",
  • "FirstLicenseDate": "01/01/2000",
  • "Name": "José",
  • "RG": "123456789",
  • "Code": "12345678910",
  • "RegistrationNumber": "01234567",
  • "Renach": "789456123",
  • "SecurityCode": "123456",
  • "MirrorNumber": "78910",
  • "CRM": "5-549788-5/PR",
  • "Observation": ""
}

DocumentConfirmation

Verifica se a foto do documento corresponde ao tipo de documento informado.

Authorizations:
(AuthorizationAPIKEY)
Request Body schema: application/json
documentType
required
string

Indica o tipo do documento anexado. Para mais detalhes sobre Documentos que podem ser anexados, consulte a seção 'Enumerados'.

imagebase64
required
string

Imagem em base64 do documento (png, jpeg, jpeg).

Responses

Request samples

Content type
application/json
{
  • "documentType": "3",
  • "imagebase64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Response samples

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

Faces

Métodos para gerenciar a biometria (1:1 e FaceMatch).

FaceMatch

Verifica se a foto do documento e a foto informada são da mesma pessoa.

Authorizations:
(AuthorizationAPIKEY)
Request Body schema: application/json
Base64Selfie
required
string

Imagem em base64 da selfie (png, jpg, jpeg).

Base64Documento
required
string

Imagem em base64 do documento (png, jpeg, jpeg).

Responses

Request samples

Content type
application/json
{
  • "Base64Selfie": "\"\"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg==\"\"",
  • "Base64Documento": "\"\"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg==\"\""
}

Response samples

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