Transaction

A query submitted to the Anti-Fraud services is called a Transaction. A transaction may contain the execution of one or more services configured in the query model or informed in the request body. These services may be internal analyses or external queries that are performed on the processing conveyor. After that, based on validation rules, the status is set for the transaction.

Services and validation rules can be configured only in the query template.

A transaction is characterized by an endpoint where the required services can be informed and a set of rules validated.

Create transaction

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.

POSThttps://api.combateafraude.com/v1/transactions

Query parameters

Header parameters

Body

application/json

templateId*string

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

filesarray of object

List of files to be analysed.

attributesobject

Person or company data that can be included within the transaction request data.

metadataobject

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

_callbackUrlstring (uri)

Callback URL (webhook).

Response

200400401500

Success

Body

application/json

requestIdstring

Unique identifier of request.

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

idstring

Unique identifier of created transaction.

Example: "6021a21b3811c35ecb8dea20"

Request

JavaScriptCurlPython

const response = await fetch('https://api.combateafraude.com/v1/transactions?origin=text', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "templateId": "text"
    }),
});
const data = await response.json();

Response

200400401500

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

List transactions

Get your transaction list summarized with pagination and filters.

GEThttps://api.combateafraude.com/v1/transactions

Query parameters

Header parameters

Response

200401500

Success

Body

application/json

requestId*string

Unique identifier of request.

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

items*array of any of

List of transactions.

totalItems*integer

Total amount of transactions according to the filter used.

Example: 2

Request

JavaScriptCurlPython

const response = await fetch('https://api.combateafraude.com/v1/transactions', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200401500

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

Retrieve the result data of a transaction.

GEThttps://api.combateafraude.com/v1/transactions/{transactionId}

Path parameters

transactionId*string

Transaction identifier.

Query parameters

Header parameters

Response

200400401500

Success

Body

application/json

requestId*string

Unique identifier of request.

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

id*string

Unique identifier of transaction.

Example: "6388a3e9a73b280008ba31ad"

status*enum

Status of transaction.

Example: "APPROVED"

PROCESSINGAPPROVEDREPROVEDPENDINGPENDING_OCR

customStatusstring

Indicates the transaction's current status using merchant-defined custom definitions pre-configured in the Trust Platform.

templateIdstring

Unique ID of the Query Template.

Example: "638a021fdeb2b90008c790d1"

onboardingIdstring

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.

attributesobject

Attributes sent when creating the transaction.

createdAt*string (date-time)

Transaction creation date.

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

typestring

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"

imagesobject

Images sent for analysis.

sections*object

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

fraudboolean

Indicates whether it is an attempt at fraud or not.

Example: false

filesarray of object

Other files linked to the transaction. Note that these values are only returned for transactions that originated from the service Web Onboarding.

documentscopyRequestDatestring (date-time)

Datetime the document went to documentscopy.

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

relatedTransactionsobject

List of related transactions, usually coming from Web Onboarding that generates more than one transaction. This field will only be returned if the query parameter _includePfRelationships is set to true.

history*array of object

Timeline of the main transaction updates.

statusReasons*array of object

Compilation of reasons that define the current status of the transaction.

manualReprovalReasonsarray of object

Compiled manual fail reasons defined by CAF support.

variablesobject

Variables of Web Onboarding.

metadataobject

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

Request

JavaScriptCurlPython

const response = await fetch('https://api.combateafraude.com/v1/transactions/{transactionId}', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200400401500

{
  "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"
      }
    ],
    "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",
    "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"
  },
  "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,
      "user": null,
      "date": null,
      "reviewType": null
    }
  ],
  "manualReprovalReasons": [
    {
      "code": "50",
      "reason": "Documento ilegível: qualidade da foto está ruim."
    }
  ]
}