Transaction

Last updated 1 month ago

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.

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.

Example: Bearer your_token_here

Body

templateIdstringRequired

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

filesobject[]Optional

List of files to be analysed.

attributesobjectOptional

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

metadataobjectOptional

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

_callbackUrlstring · uriOptional

Callback URL (webhook).

Responses

application/json

objectOptional

application/json

post

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

{
  "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"
  },
  "metadata": {},
  "_callbackUrl": "https://example.com"
}

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

Get transaction

get

Retrieve the result data of a transaction.

Path parameters

transactionIdstringRequired

Transaction identifier.

Query parameters

_includePfRelationshipsbooleanOptional

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

_includeCroppedImagesbooleanOptional

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

_langstringOptional

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

objectOptional

application/json

get

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": "+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",
    "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": "+5511999999999",
        "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": {}
}

List transactions

get

Get your transaction list summarized with pagination and filters.

Query parameters

_limitnumberOptional

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

_orderstringOptional

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

_templatesstringOptional

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

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

_endCreatedDatestring · dateOptional

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.

Example: Bearer your_token_here

Responses

application/json

objectOptional

application/json

get

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
}