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.

Last updated 2 years ago

Was this helpful?

List transactions

Get your transaction list summarized with pagination and filters.

get

/transactions

Query parameters

_limitnumber

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

_orderstring

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

_templatesstring

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 · date

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

_endCreatedDatestring · date

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

Header parameters

Authorizationstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.combateafraude.com/v1/transactions' \
  --header 'Authorization: text'

200

401

500

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

Success

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.

post

/transactions

Query parameters

originstringrequired

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

Header parameters

Authorizationstringrequired

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

Body

templateIdstringrequired

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

metadataobject

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

_callbackUrlstring · uri

Callback URL (webhook).

attributesobject

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

filesobject[]

List of files to be analysed.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.combateafraude.com/v1/transactions?origin=text' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"templateId":"text","metadata":{},"attributes":{},"files":[{"data":"text"}]}'

200

400

401

500

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

Success

Get transaction

Retrieve the result data of a transaction.

get

/transactions/{transactionId}

Path parameters

transactionIdstringrequired

Transaction identifier.

Query parameters

_includePfRelationshipsboolean

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

_includeCroppedImagesboolean

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

_langstring

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

Header parameters

Authorizationstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.combateafraude.com/v1/transactions/{transactionId}' \
  --header 'Authorization: text'

200

400

401

500

{
  "requestId": "2b8f373-c462-4bbf-9a4f-8aeb7d71ec53",
  "id": "6388a3e9a73b280008ba31ad",
  "customStatus": null,
  "templateId": "638a021fdeb2b90008c790d1",
  "onboardingId": null,
  "createdAt": "2022-09-08T22:10:14.816Z",
  "type": "cnh",
  "sections": {},
  "fraud": false,
  "documentscopyRequestDate": "2022-09-08T22:11:05.816Z",
  "variables": {},
  "metadata": {},
  "status": "APPROVED",
  "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"
  },
  "files": [
    {
      "name": "Address proof",
      "src": "https://example.com/address-proof.pdf"
    }
  ],
  "history": [
    {
      "type": "STATUS_UPDATE",
      "status": "REPROVED",
      "date": "2022-09-08T22:12:17.816Z"
    }
  ],
  "manualReprovalReasons": [
    {
      "code": "50",
      "reason": "Documento ilegível: qualidade da foto está ruim."
    }
  ],
  "attributes": {
    "cpf": "00011122233",
    "nit": "123456789",
    "phoneNumber": "+5511999999999",
    "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",
    "customForms": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "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",
    "address": {
      "street": "Main St",
      "number": "123",
      "complement": "Apartment 45",
      "neighborhood": "Downtown",
      "zipCode": "12345678",
      "city": "São Paulo",
      "state": "SP"
    },
    "employee": {
      "name": "John Doe",
      "occupation": "Software Engineer",
      "email": "[email protected]",
      "phoneNumber": 5511999999999
    },
    "coordinates": {
      "latitude": -23.55052,
      "longitude": -46.633308,
      "accuracy": 5
    },
    "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": "+5511999999999",
        "onboardingId": "abcd1234",
        "onboardingToken": "xyz987"
      }
    ],
    "partners": [
      {
        "documentNumber": 11122233,
        "cpf": 11122233,
        "partialCpf": "000.111.***",
        "name": "John Doe",
        "participation": 50,
        "type": "Administrator"
      }
    ]
  },
  "relatedTransactions": {},
  "statusReasons": [
    {
      "resultStatus": "APPROVED",
      "resultCustomStatus": "text",
      "code": "facematch_is_equal",
      "status": "VALID",
      "description": null,
      "date": null,
      "category": "VALIDATION",
      "reviewType": null,
      "descriptions": [
        null
      ],
      "user": null
    }
  ]
}

Success