# Obter uma transação

Esta seção tem como objetivo detalhar a obtenção dos dados de uma transação.

# Requisição

Path params

# transactionId
Identificador da transação.

Query string params

# _includePfRelationships Boolean Opcional
Flag para incluir transações relacionadas ao onboarding pf_pf. Incluir: _includePfRelationships=true

# _includeCroppedImages Boolean Opcional

Flag para incluir as versões recortadas das imagens dos documentos enviados.
Incluir: _includeCroppedImages=true

# _lang String Opcional

Flag para definir a linguagem na descrição dos motivos das reprovações manuais.
Português (Padrão): _lang=pt
Inglês: _lang=en

# Resposta

# requestId String
Identificador único da requisição realizada.
# id String
Identificador único da transação.
# status String
Indica o status em que a transação se encontra, sendo: APPROVED, REPROVED, PENDING, PENDING_OCR ou PROCESSING.
# customStatus String
Indica o status personalizado (definido pelo cliente) em que a transação se encontra.
# type String
Indica o tipo do documento enviado.
# createdAt String
Indica a data de criação da transação.
# sections Object
Contêm os dados dos serviços executados. Cada atributo representa um serviço.
# statusReasons Array of object
Compilado de motivos que definem o status atual da transação.
Atributos de statusReasons

# category String

Categoria do motivo, sendo elas: VALIDATION ou MANUAL_REVIEW.

# descriptions String

Descrição do motivo.

# resultStatus String

Status empregado na transação caso o motivo se aplique.

# resultCustomStatus String

Status personalizado (definido pelo cliente) empregado na transação caso o motivo se aplique.

# code String

Código da validação (apenas quando o category for VALIDATION).

# status String

Status da validação (apenas quando o category for VALIDATION).

# manualReprovalReasons Array of object
Compilado de motivos de reprovação manuais definidos pelo suporte da caf.
Atributos de manualReprovalReasons

# code String

Código da reprovação.

# reason String

Motivo da reprovação.

# images Object
Imagens enviadas na transação.
Atributos de images

# back String

URL do verso do documento.

# front String

URL da frente do documento.

# selfie String

URL da selfie.

# selectedFront String

URL da frente do documento na versão recortada (quando incluso).

# selectedBack String

URL do verso do documento na versão recortada (quando incluso).

# attributes Object
Informações adicionais vinculadas à transação.
Atributos de attributes

# cpf String

# phoneNumber String

# name String

# email String

# birthDate String

# cnpj String

# fantasyName String

# officialName String

# monthlyBilling String

# annuallyBilling String

# customForms Object

# acceptedTermsData Array of objects

Termos que o usuário aceitou ao realizar o onboarding.

Atributos de acceptedTermsData

# name String

Nome do termo.

# datetime String

Data em que o usuário aceitou o termo.

# userIp String

IP utilizado pelo usuário que aceitou o termo.

# userAgent String

Sistema operacional e plataforma utilizada pelo usuário.

# address Object

Endereço vinculado à transação.

Atributos de address

# street String

Rua.

# number String

Número da residência.

# complement String

Complemento do endereço.

# neighborhood String

Bairro.

# zipCode String

CEP.

# city String

Cidade.

# state String

Estado.

# relationships Array of objects

Informações de relacionamentos enviadas na transação.

Atributos de relationships

# cpf String

# cnpj String

# customForms Object

(Em desenvolvimento)

# relatedTransactions Object
Lista de transações relacionadas.
Atributos de relatedTransactions

# pf Array of objects

Array de transações relacionadas do tipo Pessoa Física, normalmente utilizado no onboarding pf_pf.

Atributos de pf

# transactionId String

Identificador único da transação relacionada.

# onboardingId String

Identificador único do onboarding que gerou a transação relacionada.

# onboardingId String
Identificador único do onboarding que gerou a transação.
# files Array of objects
Outros arquivos vinculados na transação, oriundos do fluxo do produto onboarding web.
Atributos de files

# name String

Nome do arquivo.

# src String

URL do arquivo.

# variables Object
Variáveis do produto onboarding web.