Criar uma nova transação

Na Transação são enviados os dados do consumidor que o cliente deseja consultar nos módulos da Plataforma Data Trust.

📘

Endereço dos nossos serviços:

Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/
Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/

Acesse aqui a documentação técnica

Para criar uma transação na Plataforma Data Trust, utilize o token gerado anteriormente.

A criação de uma transação é necessária para que seja gerado um ID único, chamado de Transaction Id, vinculado aos dados do cliente a ser consultado nos módulos da Plataforma Data Trust.

A resposta da chamada da Transação agregará o campo “Id”, comumente chamado de Transaction Id, que deve ser utilizado em todas as chamadas dos endpoints dos módulos em que deseja obter os resultados relacionados aos dados do cliente enviados na transação.

Campos Genéricos (genericFields)

A inclusão de campos genéricos foi pensada para que o cliente possa inserir nas mensagens de texto de 2FA (inicialmente somente via WhatsApp), variáveis que somente a empresa cliente tem acesso aos dados e que façam sentido para o entendimento do contexto da mensagem pelo seu cliente / consumidor.

Para o envio de campos genéricos para uso na mensagem de 2FA é necessário alinhamento prévio, para que então o campo passe a ser considerado no envio da transação.

Uma vez que os campos estejam mapeados, é possível adicionar uma máscara para validar o dado enviado, como por exemplo enviar somente letras, enviar uma data, um valor monetário, etc.

Se você tem interesse em enviar campos genéricos na mensagem de 2FA entre em contato com o [email protected]

Dicionário de Variáveis de Entrada

Apenas o CPF é obrigatório na criação de uma Transação, porém, conforme o módulo a ser chamado posteriormente, outros parâmetros de entrada podem tornar-se imprescindíveis para a correta e assertiva resposta do módulo.

ParâmetroDescriçãoTipoTamanhoObrigatório
DocumentType Tipo do documento do cliente (CPF ou CNPJ*) String 4Sim
Document Documento do cliente (Sem pontuação) String 14 Sim
NameNome completo do cliente (Sem abreviação) String 300 Não
BirthdateData de nascimento do cliente [YYYY-MM-DD] String 10 Não
EmailEmail do cliente String 200 Não
MothersNameNome completo da mãe (Sem abreviação) String 300Não
VerifiedEmail Flag de Email verificado Boolean -Não
SessionID Chave do device do cliente String 200 Não
Address Objeto com informações do endereço do cliente Address -Não
Phone Objeto com informações do número de telefone celular do cliente Phone -Não
ReferenceDate Data de referência da transação DateTime -Não
Type Tipo da transação
(1- Presencial; 2- Online)
Int 1Não
ChannelId Chave da subentidade Int -Não
IdentifierIdID interno controlado pelo clienteString100Não
IdentifierDateData de identificação da transaçãoDateTime-Não
GenericFieldsCampos Genéricos previamente configuradosString-Não

Address

NomeDescriçãoTipoTamanhoObrigatório
ZipCodeCódigo Postal do endereço do clienteString8Não
StreetEndereço do clienteString200Não
NumberNúmero do endereço do clienteString15Não
ComplementComplemento do endereço do clienteString150Não
DistrictDistrito do endereço do clienteString150Não
CityCidade do clienteString150Não
StateEstado do clienteString2Não
CountryPaís do clienteString150Não

Phone

NomeDescriçãoTipoTamanhoObrigatório
CountryCodeCódigo de país do número de telefone celular do clienteInt3Sim
AreaCodeCódigo de área do número de telefone celular do cliente - DDDInt2Sim
NumberNúmero de telefone celular do clienteInt9Sim
VerifiedFlag de número de telefone celular verificadoBolean-Não

*Para a consulta de CNPJ, apenas os módulos de score e insights estão disponíveis