Request Device Creation

Request

ENDPOINT

/account/ACCOUNT_KEY/device

METHOD

POST

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36

SMS

Request Body: SMS Authentication

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

Body Params

Field	Type	Description	Characters
device_key *	uuidv4	Unique device identification key in uuid v4 format, obtained through device_scan (created at this moment by the integrating client).	36
session_id *	uuidv4	Unique session identification key in uuid v4 format, obtained through device_scan (created at this moment by the integrating client).	36
tfa_info*	Object	Object containing the approver's document number and contact method or image_key.	tfa_info Object

tfa_info Object

Field	Type	Description	Characters
approver_document_number*	string	Document number of the account approver.	11
contact_type*	string	Indicates the contact method with the person responsible for account approval. Possible values are sms, email, or liveness (when authentication is performed using image_key).

Response

STATUS

202

Response Body: Transaction Requested

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

Email

Request Body: Email Authentication

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

Body Params

Field	Type	Description	Characters
device_key *	uuidv4	Unique device identification key in uuid v4 format, obtained through device_scan (created at this moment by the integrating client).	36
session_id *	uuidv4	Unique session identification key in uuid v4 format, obtained through device_scan (created at this moment by the integrating client).	36
tfa_info*	Object	Object containing the approver's document number and contact method or image_key.	tfa_info Object

tfa_info Object

Field	Type	Description	Characters
approver_document_number*	string	Document number of the account approver.	11
contact_type*	string	Indicates the contact method with the person responsible for account approval. Possible values are sms, email, or liveness (when authentication is performed using image_key).

Response

STATUS

202

Response Body: Transaction Requested

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

Image Key

Request Body: Image Key Authentication

{
    "device_key": "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

Field	Type	Description	Characters
device_key *	uuidv4	Unique device identification key in uuid v4 format, obtained through device_scan (created at this moment by the integrating client).	36
session_id *	uuidv4	Unique session identification key in uuid v4 format, obtained through device_scan (created at this moment by the integrating client).	36
tfa_info*	Object	Object containing the approver's document number and contact method or image_key.	tfa_info Object

tfa_info Object

Field	Type	Description	Characters
approver_document_number*	string	Document number of the account approver.	11
contact_type*	string	Indicates the contact method with the person responsible for account approval. Possible values are sms, email, or liveness (when authentication is performed using image_key).
image_key *	uuidv4	Unique identification key of the image used for facial recognition, in UUID v4 format, obtained through the liveness process.	36

Response

STATUS

202

Response Body: Device Created

{
  "device_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "device_status": "created",
  "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": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (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 Key must be a valid UUID4	A Session ID e o Device Key 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