Solicitar Criação de Dispositivo

Request

ENDPOINT

/account/ACCOUNT_KEY/device

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta.	36

SMS

Request Body: Autenticação via SMS

{
    "device_id": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "session_id": "fae3cb6c-9012-4b1c-9d61-7e8b2a6a5ed2",
    "tfa_info": {
        "approver_document_number": "98765432100",
        "contact_type": "sms",
    },
}

Body Params

Campo	Tipo	Descrição	Caracteres
device_id *	uuidv4	Chave única de identificação do dispositivo no formato uuid v4, adquirida atráves da device_scan (criada nesse momento pelo cliente integrador).	36
session_id *	uuidv4	Chave única de identificação da sessão no formato uuid v4, adquirida atráves da device_scan (criada nesse momento pelo cliente integrador).	36
tfa_info*	Object	Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato ou image_key.	Objeto tfa_info

Objeto tfa_info

Campo	Tipo	Descrição	Caracteres
approver_document_number*	string	Número de documento da pessoa aprovadora da conta.	11
contact_type*	string	Indica o método de contato com a pessoa responsável pela aprovação da conta. Os valores possíveis são sms, email, ou liveness (quando a autenticação for realizada utilizando image_key).

Email

Request Body: Autenticação via Email

{
    "device_id": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "session_id": "fae3cb6c-9012-4b1c-9d61-7e8b2a6a5ed2",
    "tfa_info": {
        "approver_document_number": "98765432100",
        "contact_type": "email",
    },
}

Body Params

Campo	Tipo	Descrição	Caracteres
device_id *	uuidv4	Chave única de identificação do dispositivo no formato uuid v4, adquirida atráves da device_scan (criada nesse momento pelo cliente integrador).	36
session_id *	uuidv4	Chave única de identificação da sessão no formato uuid v4, adquirida atráves da device_scan (criada nesse momento pelo cliente integrador).	36
tfa_info*	Object	Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato ou image_key.	Objeto tfa_info

Objeto tfa_info

Campo	Tipo	Descrição	Caracteres
approver_document_number*	string	Número de documento da pessoa aprovadora da conta.	11
contact_type*	string	Indica o método de contato com a pessoa responsável pela aprovação da conta. Os valores possíveis são sms, email, ou liveness (quando a autenticação for realizada utilizando image_key).

Image Key

Request Body: Autenticação via Image Key

{
    "device_id": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "session_id": "fae3cb6c-9012-4b1c-9d61-7e8b2a6a5ed2",
    "tfa_info": {
        "approver_document_number": "98765432100",
        "contact_type": "liveness",
        "image_key": "367195fc-de24-46b0-9ddb-79231dc7eeff",
    },
}

Body Params

Campo	Tipo	Descrição	Caracteres
device_id *	uuidv4	Chave única de identificação do dispositivo no formato uuid v4, adquirida atráves da device_scan (criada nesse momento pelo cliente integrador).	36
session_id *	uuidv4	Chave única de identificação da sessão no formato uuid v4, adquirida atráves da device_scan (criada nesse momento pelo cliente integrador).	36
tfa_info*	Object	Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato ou image_key.	Objeto tfa_info

Objeto tfa_info

Campo	Tipo	Descrição	Caracteres
approver_document_number*	string	Número de documento da pessoa aprovadora da conta.	11
contact_type*	string	Indica o método de contato com a pessoa responsável pela aprovação da conta. Os valores possíveis são sms, email, ou liveness (quando a autenticação for realizada utilizando image_key).
image_key *	uuidv4	Chave única de identificação da imagem utilizada para reconhecimento facial, no formato UUID v4, obtida por meio do processo de liveness.	36

Response

STATUS

202

Response Body: Transação Solicitada

{
  "device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "device_status": "pending_2fa_approval",
  "created_at": "2024-12-22T20:30:23.459Z"
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Erro de Schema
404	OBD000002	Not Found	Bank account not found	Conta não encontrada
400	OBD000088	Bad Request	Account blocked or closed can not perform this action	A conta bloqueada ou fechada não pode executar esta ação
400	OBD000089	Bad Request	Hub account can not perform this action	A conta hub não pode executar esta ação
403	OBD000090	No approver permission	Given document number does not belong to an approver for this account string	Número de documento enviado não pertence a um aprovador da conta
400	OBD000091	tfa_info is required	Client must send object tfa_info	Cliente deve enviar objeto tfa_info.
400	OBD000092	Invalid device info	Session ID and Device ID must be a valid UUID4	A Session ID e o Device ID devem ser um UUID4 válidos
404	OBD000093	Requester Configuration not found	There is no Requester Configuration attributed to requester_key	Não há Requester Configuration para a requester_key enviada
403	OBD000094	Requester not allowed to create a device	Requester has no permission to create a device	Requester não possui permissão para criar um dispositivo
400	OBD000097	Error occurred while sending token	An unexpected error occurred while sending token	Um erro inexperado ocorreu ao tentar enviar token