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 (Disponível para uso nos textos das mensagens 2FA SMS e 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
DocumentTypeTipo do documento do cliente (CPF ou CNPJ*)String3Sim
DocumentDocumento do cliente (Sem pontuação)String11Sim
NameNome completo do cliente (Sem abreviação)String300Não
BirthdateData de nascimento do cliente [YYYY-MM-DD]String10Não
EmailEmail do cliente (sem 3 ou mais caracteres especiais iguais em sequência)String100Não
MothersNameNome completo da mãe (Sem abreviação)String300Não
VerifiedEmailFlag de Email verificadoBoolean

Não
SessionIDChave do device do clienteString200Não
AddressObjeto com informações do endereço do clienteAddress

Não
PhoneObjeto com informações do número de telefone (fixo ou celular) do clientePhone

Não
ReferenceDateData de referência da transaçãoDateTime

Não
TypeTipo da transação
(1- Presencial; 2- Online)
Int1Não
ChannelIdChave da subentidadeInt

Não
IdentifierIdID interno controlado pelo clienteString100Não
IdentifierDateData de identificação da transaçãoDateTime

Não
GenericFieldsCampos Genéricos previamente configuradosString

Não
CriterionID com o critério para geração do módulo de credit proInt

Não
navigationidid utilizado pelo produto Biometria comportamentalString128Não
CardInformações do cartão associados a transaçãoCard

Não
SecondaryDocumentTypeTipo do documento secundário associado a transação (CPF, CNPJ ou RG)String4Não
SecondaryDocumentDocumento secundário (Sem pontuação)String14Não
VehicleForneça os dados do veículo e os detalhes da proposta de financiamentoVehicle

Não
ImageInformações da selfie e documentos para validações biométricas (Disponível apenas no Pack Sync) clique aqui para mais informaçõesImage

Não
FatherNameNome do pai do clienteString300Não
IssuanceDateDocumentData de emissão do documento principal [YYYY-MM-DD]String10Não
IssuanceDateSecondaryDocumentData de emissão do documento secundário [YYYY-MM-DD]String10Não
TradeNameNome fantasia da empresaString300Não
CnaesLista de CNAEs da empresaArray8 por itemNão
GenderGênero do cliente ("male", "female", "non-binary", "other")String4-10Não
Services.bcheckLista de serviços bcheckArray

Não
PartnersDados de ParceirosPartners

Não
LegalRepresentativesRepresentante legalLegalRepresentatives

Não
PhonesLista de telefonesArry [Phones]

Não
SocialNameNome SocialString300Não

Address

NomeDescriçãoTipoTamanhoObrigatório
ZipCodeCódigo Postal do endereço do clienteString8Sim
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

Card

NomeDescriçãoTipoTamanhoObrigatório
Bin6 ou 8 primeiros dígitos do cartãoString6Sim
Last44 últimos dígitos do cartãoString4Sim
OwnerDocumentDocument (CPF) do dono do cartãoString11Não
OwnerNameNome do dono do cartãoString300Não

Vehicle

NomeDescriçãoTipoTamanhoObrigatório
ProposedDateMenor ou igual à data atual, maior ou igual a 2000-01-01DateTime

Não
VehicleLicensePlateNão vazio, ter 7 caracteres, formato válido de placa(AAA1111 ou AAA1A11)String7Sim
StoreStateDuas letras maiúsculas ou minúsculasString2Não
LicensePlateStateDuas letras maiúsculas ou minúsculasString2Não
VehicleRegistrationStateDuas letras maiúsculas ou minúsculasString2Não
VehicleRegistrationStateExatamente duas letras maiúsculas ou minúsculasString2Não
FinancingAmountValor deve ser > 0 e estar em um formato monetário válido (9999999999.99). Valores com mais de duas casas decimais serão arredondados.double12Sim
MarketValueValor deve ser ≥ 0 e estar em um formato monetário válido (9999999999.99). Valores com mais de duas casas decimais serão arredondados.double12Não
VehicleManufacturingYearEntre 1900 e o ano atualInt

Não

Partners

NomeDescriçãoTipoTamanhoObrigatório
DocumentTypeTipo do documento do sócio (CPF ou CNPJ)String3-4Sim
DocumentDocumento do sócio (sem pontuação)String11-14Sim
NameNome do sócioString300Sim

LegalRepresentatives

NomeDescriçãoTipoTamanhoObrigatório
DocumentTypeTipo do documento do representante legal (CPF ou CNPJ)String3-4Sim
DocumentDocumento do representante legal (sem pontuação)String11-14Sim
NameNome do representante legalString300Sim

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



Did this page help you?