Transação

Esta API está obsoleta.

A Core API não é mais recomendada para novas integrações. Ela permanecerá funcional exclusivamente para clientes existentes. A migração para a Connect API é fortemente recomendada.

Para mais detalhes, consulte a Política de descontinuação.

Transação

Uma consulta enviada aos serviços Anti-Fraude é chamada de Transação. Uma transação pode conter a execução de um ou mais serviços configurados no modelo da consulta ou informados no corpo da solicitação. Esses serviços podem ser análises internas ou consultas externas realizadas na esteira de processamento. Depois disso, com base nas regras de validação, o status é definido para a transação.

Serviços e regras de validação podem ser configurados somente no modelo de consulta.

Uma transação é caracterizada por um endpoint no qual os serviços necessários podem ser informados e um conjunto de regras validadas.

Create transaction

post

Submission of the necessary person or company data and the template model against which the verification services shall be executed, as well as the set of rules to be validated.

Parâmetros de consulta

originstringObrigatório

Parameter that defines the onboarding origin. Must be set to TRUST.

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Customer access token. See more in the 'Authentication' topic of this section.

Example: Bearer your_token_here

Corpo

application/json

templateIdstringObrigatório

Unique ID of the Query Template (configured in Trust Platform).

metadataobjectOpcional

Free to add any kind of attribute, ideal for linking IDs or other information in the transaction.

referenceTokenstringOpcional

Mobile Token (Session Token).

_callbackUrlstring · uriOpcional

Callback URL (webhook).

Respostas

200

Success

application/json

requestIdstringOpcional

Unique identifier of request.

Example: 6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9

idstringOpcional

Unique identifier of created transaction.

Example: 6021a21b3811c35ecb8dea20

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/transactions

HTTPcURLJavaScriptPython

POST /v1/transactions?origin=text HTTP/1.1
Host: api.combateafraude.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 443

{
  "templateId": "text",
  "files": [
    {
      "data": "text",
      "type": "SELFIE"
    }
  ],
  "attributes": {
    "cpf": "text",
    "rg": "text",
    "name": "text",
    "birthDate": "text",
    "fatherName": "text",
    "motherName": "text",
    "uf": "text",
    "cnpj": "text",
    "cep": "text",
    "email": "[email protected]",
    "phoneNumber": "text",
    "plate": "text",
    "documentCountry": "text",
    "holderName": "text",
    "holderCpf": "text",
    "analysisDate": "2025-08-15"
  },
  "metadata": {},
  "referenceToken": "text",
  "_callbackUrl": "https://example.com"
}

{
  "requestId": "6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9",
  "id": "6021a21b3811c35ecb8dea20"
}

List transactions

get

Get your transaction list summarized with pagination and filters.

Parâmetros de consulta

_limitnumberOpcional

The maximum amount of records that should be returned in the response, e.g. _limit=5. Max value is 10 and default is 10.

_offsetnumberOpcional

The number of records to skip before starting to collect the result set, e.g. _offset=5. Default is 0.

_orderstringOpcional

Sort the records returned in response by creation date in ascending or descending order. Descending (default): _order=desc Ascending : _order=asc

_templatesstringOpcional

Search for too many template models by references of the templateId on the account. For multiple templates, separate the values using the pipe symbol, e.g. _templates=templateId1|templateId2|templateId3.

_startCreatedDatestring · dateOpcional

Search the records created on or after any given day, e.g. _startCreatedDate=2022-01-01.

_endCreatedDatestring · dateOpcional

Search the records created on or before a specified day, e.g. _endCreatedDate=2022-01-30.

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Customer access token. See more in the 'Authentication' topic of this section.

Example: Bearer your_token_here

Respostas

200

Success

application/json

requestIdstringObrigatório

Unique identifier of request.

Example: 6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9

totalItemsintegerObrigatório

Total amount of transactions according to the filter used.

Example: 2

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/transactions

HTTPcURLJavaScriptPython

GET /v1/transactions HTTP/1.1
Host: api.combateafraude.com
Authorization: text
Accept: */*

{
  "requestId": "6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9",
  "items": [
    {
      "id": "6388ac6b409eff000804dadf",
      "status": "APPROVED",
      "createdAt": "2022-09-08T22:10:14.816Z",
      "data": {
        "cpf": "00011122233",
        "birthDate": "01/01/2000",
        "name": "John Doe"
      }
    }
  ],
  "totalItems": 2
}

Get transaction

get

Retrieve the result data of a transaction.

Parâmetros de rota

transactionIdstringObrigatório

Transaction identifier.

Parâmetros de consulta

_includePfRelationshipsbooleanOpcional

Flag for including transactions related to onboarding pf_pf. e.g. _includePfRelationships=true.

Default: false

_includeCroppedImagesbooleanOpcional

Flag to include the cropped versions of the images of the sended documents. e.g. _includeCroppedImages=true.

Default: false

_langstringOpcional

Flag to set the language in the description of the reasons for manual failures. Possible values are 'en' or 'pt'. e.g. _lang=en.

Default: pt

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Customer access token. See more in the 'Authentication' topic of this section.

Respostas

200

Success

application/json

requestIdstringObrigatório

Unique identifier of request.

Example: 2b8f373-c462-4bbf-9a4f-8aeb7d71ec53

idstringObrigatório

Unique identifier of transaction.

Example: 6388a3e9a73b280008ba31ad

statusstring · enumObrigatório

Status of transaction.

Example: APPROVEDValores possíveis:

customStatusstring · anulávelOpcional

Merchant-defined custom status configured in Trust. There is no global enum because the available values are specific to each tenant. Returns null when no custom status applies.

templateIdstringOpcional

Unique ID of the Query Template.

Example: 638a021fdeb2b90008c790d1

onboardingIdstringOpcional

Unique identifier of the onboarding that generated the transaction. Note that these values are only returned for transactions that originated from the service Web Onboarding.

createdAtstring · date-timeObrigatório

Transaction creation date.

Example: 2022-09-08T22:10:14.816Z

typestringOpcional

Document type sent:

• "rg" (Brazilian General Registry) The RG is a document used to identify Brazilian citizens.

• "cnh" (Brazilian Driver's License) It is a mandatory document for any citizen who intends to drive a motor vehicle.

• "crlv" (Vehicle Registration and License Certificate) Is the document issued annually to indicate that the vehicle is fit to circulate on Brazilian streets.

• "rne" (Brazilian Foreigner Registry) Is a document that certifies the identity of foreign individuals with temporary or permanent residence in Brazil.

• "rnm" (Brazilian Migratory Registry) Is the alphanumeric register number resulting from the identification of each immigrant through his or her personal information and fingerprints.

• "ctps" (Employment and Social Security Card) Is a document that contains information about the worker's professional life and his affiliation to the National Institute of Social Security - INSS.

• "passport" Personal and non-transferable document, issued by the authority of a State for the free transit of its nationals in the country that admits them to its territory.

• "outros" (Others) When there is a document in the image but it is not of a type mapped by us.

• "invalido" (Invalid) When there is no document in the image.

Example: cnh

sectionsobjectObrigatório

Contains the data on the services performed as defined by the Query template. Each attribute represents a service.

fraudbooleanOpcional

Indicates whether it is an attempt at fraud or not.

Example: false

documentscopyRequestDatestring · date-timeOpcional

Datetime the document went to documentscopy.

Example: 2022-09-08T22:11:05.816Z

variablesobjectOpcional

Variables of Web Onboarding.

metadataobjectOpcional

Some internal control fields + the fields sent in the metadata attribute of the transaction creation.

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get/transactions/{transactionId}

HTTPcURLJavaScriptPython

GET /v1/transactions/{transactionId} HTTP/1.1
Host: api.combateafraude.com
Authorization: text
Accept: */*

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "6388a3e9a73b280008ba31ad",
  "status": "APPROVED",
  "customStatus": null,
  "templateId": "638a021fdeb2b90008c790d1",
  "onboardingId": null,
  "attributes": {
    "cpf": "00011122233",
    "nit": "123456789",
    "phoneNumber": "[phone]",
    "name": "John Doe",
    "email": "[email protected]",
    "birthDate": "1990-01-01",
    "companyId": "123456789",
    "cnpj": "12345678000195",
    "fantasyName": "Doe Enterprises",
    "officialName": "Doe & Partners Ltda.",
    "monthlyBilling": "50000.00",
    "annuallyBilling": "600000.00",
    "scoreCheckGroup": "A",
    "address": {
      "street": "Main St",
      "number": "123",
      "complement": "Apartment 45",
      "neighborhood": "Downtown",
      "zipCode": "12345678",
      "city": "São Paulo",
      "state": "SP"
    },
    "acceptedTermsData": [
      {
        "name": "Privacy Policy",
        "link": "https://example.com/privacy",
        "datetime": "2024-01-01T12:00:00Z",
        "userIp": "192.168.0.1",
        "userAgent": "Mozilla/5.0"
      }
    ],
    "customForms": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "relationships": [
      {
        "cpf": "00011122233",
        "cnpj": "12345678000195"
      }
    ],
    "qsa": [
      {
        "documentNumber": "00011122233",
        "cpf": "00011122233",
        "partialCpf": "***.111.222-**",
        "name": "Jane Doe",
        "email": "[email protected]",
        "phoneNumber": "[phone]",
        "onboardingId": "abcd1234",
        "onboardingToken": "xyz987"
      }
    ],
    "employee": {
      "name": "John Doe",
      "occupation": "Software Engineer",
      "email": "[email protected]",
      "phoneNumber": 5511999999999
    },
    "coordinates": {
      "latitude": -23.55052,
      "longitude": -46.633308,
      "accuracy": 5
    },
    "deviceId": "12345abcd",
    "userIp": "192.168.0.1",
    "monthlyIncome": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "occupation": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "motherName": "Mary Doe",
    "issueDate": "2024-01-01",
    "rg": 12345678,
    "rgIssueDate": "2024-01-01",
    "partners": [
      {
        "documentNumber": 11122233,
        "cpf": 11122233,
        "partialCpf": "000.111.***",
        "name": "John Doe",
        "participation": 50,
        "type": "Administrator"
      }
    ]
  },
  "createdAt": "2022-09-08T22:10:14.816Z",
  "type": "cnh",
  "images": {
    "back": "https://example.com/image-back.jpg",
    "front": "https://example.com/image-front.jpg",
    "selfie": "https://example.com/selfie.jpg",
    "selectedBack": "https://example.com/image-back-cropped.jpg",
    "selectedFront": "https://example.com/image-front-cropped.jpg"
  },
  "sections": {},
  "fraud": false,
  "files": [
    {
      "name": "Address proof",
      "src": "https://example.com/address-proof.pdf"
    }
  ],
  "documentscopyRequestDate": "2022-09-08T22:11:05.816Z",
  "relatedTransactions": {},
  "history": [
    {
      "type": "STATUS_UPDATE",
      "status": "REPROVED",
      "date": "2022-09-08T22:12:17.816Z"
    }
  ],
  "statusReasons": [
    {
      "category": "VALIDATION",
      "resultStatus": "APPROVED",
      "resultCustomStatus": "text",
      "code": "facematch_is_equal",
      "status": "VALID",
      "description": null,
      "descriptions": [
        null
      ],
      "user": null,
      "date": null,
      "reviewType": null
    }
  ],
  "manualReprovalReasons": [
    {
      "code": "50",
      "reason": "Documento ilegível: qualidade da foto está ruim."
    }
  ],
  "variables": {},
  "metadata": {}
}

Aviso Importante sobre Integrações

Para garantir a estabilidade e a segurança dos nossos serviços, é obrigatório implementar integrações com as APIs da Caf exclusivamente via backend/lado do servidor, pois chamadas pelo front-end (via navegador ou lado do cliente) podem ser bloqueadas pelos nossos sistemas quando múltiplos IPs ou user agents de navegador são detectados. Além disso, integrações no lado do cliente expõem as chaves de autenticação ao risco de vazamento e uso malicioso, o que pode levar ao consumo não autorizado de recursos e cobranças adicionais. As chaves de autenticação encontradas em uso em implementações incorretas serão desativadas imediatamente.

Sempre recomendamos: (1) implementar no backend, (2) usar cabeçalhos e autenticação adequados e (3) nunca expor credenciais no lado do cliente. Consulte nossa documentação para mais detalhes ou entre em contato com nossa equipe de suporte técnico.