Transactions

A Transaction is a name given to a query submitted to CAF services. The resource called transactions provides the ability for direct consumption of all active services using a single API request containing the data of an individual or company.

These services may be internal analyses or external queries that are performed on the processing conveyor. After that, based on validation rules set up in your workflow, the status is set for the transaction.

Last updated 9 months ago

Was this helpful?

List transactions

Get your transaction list summarized with pagination and filters.

Permission required: Transactions read

get

/transactions

Query parameters

startCreatedDatestring · date

It is considered for filtering transactions created from this date on. Format date must be ISO 8601.

endCreatedDatestring · date

It is considered for filtering transactions created until this date. Format date must be ISO 8601.

statusstring · enum

Status is used for filtering transactions with the same status.

Options: APPROVED, REPROVED, PROCESSING, PENDING

workflowIdstring

Workflow unique identifier. It is created on the Trust platform, and you can access it there to get this identifier.

limitnumber · min: 1 · max: 10 · default: 10

It is used to set how many records can be returned in the response, from 1 to 10. The default value is 10.

orderstring · enum · default: desc

Used to define transaction sort order according to its creation time. The default is descending.

Options: asc, desc

cursorstring

Used for pagination. If provided, it will be used for skipping records. You must use one of the values present on the pagination object from some previous response.

pagestring · enum · default: next

Used for pagination. Indicates whether the page after the provided cursor or before it should be returned. The default value is next.

Options: next, prev

Header parameters

Authorizationstringrequired

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

Example: Bearer YOUR_TOKEN

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.public.caf.io/v1/orchestrations/transactions' \
  --header 'Authorization: text'

200

400

401

403

500

{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "List transactions successfully",
  "pagination": {
    "previousPage": "66785E9c785dAZW0f14c46a8",
    "nextPage": "66785E9c785dAZW0f14c46a8"
  },
  "data": {
    "items": [
      {
        "id": "2644c29d110224f35ee70593",
        "workflowId": "689275573ee09aJOfTeAefbd",
        "createdAt": "2024-05-15T14:13:14.855Z",
        "status": "APPROVED"
      }
    ]
  }
}

Success

Update transaction manual reviews

Update reviews in a transaction that have pending reviews.

If your workflow contains more than one rule in the same step, it will be necessary to change all rule statuses for the flow to proceed/complete.

Permission required: Manual reviews update

patch

/transactions/{transactionId}/manual-reviews

Path parameters

transactionIdstringrequired

Transaction unique identifier. It must be a valid id.

Header parameters

Authorizationstringrequired

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

Example: Bearer YOUR_TOKEN

Body

reviewsobject[]

List containing all the reviews that will be updated on the transaction.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.public.caf.io/v1/orchestrations/transactions/{transactionId}/manual-reviews' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"reviews":[{"id":"64b691668251ce3fd54fJ0t4","type":"RULE","status":"REPROVED"}]}'

200

400

401

404

500

{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "Transaction reviewed successfully",
  "data": {
    "transactionId": "6ax4c39c4964980e578ecb15"
  }
}

Success

Get transaction

Retrieve the result data of a transaction.

Permission required: Transactions read

get

/transactions/{transactionId}

Path parameters

transactionIdstringrequired

Transaction unique identifier. It must be a valid id.

Header parameters

Authorizationstringrequired

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

Example: Bearer YOUR_TOKEN

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.public.caf.io/v1/orchestrations/transactions/{transactionId}' \
  --header 'Authorization: text'

200

400

401

403

404

500

{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "Transaction retrieved successfully",
  "data": {
    "id": "26J0T49d250224f35ee72478",
    "createdAt": "2024-05-15T14:13:14.855Z",
    "updatedAt": "2024-05-15T14:13:14.855Z",
    "workflowId": "66J0T49d250224f35ee72478",
    "status": "APPROVED",
    "parameters": {
      "birthDate": "string",
      "dateFormat": "dd/MM/yyyy",
      "name": "string",
      "phoneNumber": "string",
      "address": "string",
      "nationalId": "string",
      "zipCode": "string",
      "countryCode": "MX",
      "creditReportId": "string",
      "businessIdentityId": "string"
    },
    "metadata": {
      "externalId": "customerIdXX989"
    },
    "files": [
      {
        "type": "SELFIE",
        "data": "string"
      },
      {
        "type": "FRONT",
        "data": "string"
      },
      {
        "type": "BACK",
        "data": "string"
      }
    ],
    "validations": [
      {
        "ruleId": "66j0t4a33c7bd6f580dfa21e",
        "ruleName": "Good match - reliability 10 1x1 novo",
        "createdAt": "2024-05-15T14:13:14.855Z",
        "status": "APPROVED"
      }
    ],
    "sections": {
      "globalIdentityVerifications": {
        "statusCode": "01",
        "message": "Successfully",
        "query": {},
        "data": {
          "detailList": "",
          "adaptation": "0",
          "detailCode": "WS-9603782.2024.4.15.14.13.43.676",
          "reliability": "10",
          "query": {
            "options": "identityverify;messageverbose;debug"
          },
          "messages": [
            {
              "value": "Identity could not be verified with service AddressLoq for country BR",
              "code": "WV-AddressLoq-BR"
            }
          ]
        }
      }
    }
  }
}

Successful operation

Create transactions

This resource works for persons and companies and is responsible for creating a new transaction using the received data.

As it is a workflow-based solution, creating a workflow on the Trust platform is required before using this service. To learn more about the workflow setup, you can find more details here.

To understand the required parameters for each type of analysis (person or company) depending on the services used on the validations set for your workflow, you can check it on the KYC and KYB topics in this section.

Permission required: Transactions create

post

/transactions

Header parameters

Authorizationstringrequired

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

Example: Bearer YOUR_TOKEN

Body

workflowIdstringrequired

Workflow unique identifier. It is created on the Trust platform, and you can access it there to get this identifier.

Example: 6644cerd257785f35ee70592

metadataobject

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

parametersobjectrequired

Person or company data that can be included within the transaction request data. If a service in your workflow requires a parameter property and you don't include it in the payload, the service response will fail with a message informing the missing parameter.

Example:

{"birthDate":"string","dateFormat":"dd/MM/yyyy","name":"string","phoneNumber":"string","address":"string","nationalId":"string","zipCode":"string","countryCode":"MX","creditReportId":"string","businessIdentityId":"string"}

filesobject[]

List of files to be analyzed.

Example: [{"type":"SELFIE","data":"string"},{"type":"FRONT","data":"string"},{"type":"BACK","data":"string"}]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.public.caf.io/v1/orchestrations/transactions' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"workflowId":"6644cerd257785f35ee70592","metadata":{},"parameters":{"birthDate":"string","dateFormat":"dd/MM/yyyy","name":"string","phoneNumber":"string","address":"string","nationalId":"string","zipCode":"string","countryCode":"MX","creditReportId":"string","businessIdentityId":"string"},"files":[{"type":"SELFIE","data":"string"},{"type":"FRONT","data":"string"},{"type":"BACK","data":"string"}]}'

201

400

401

403

404

500

{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "Transaction created successfully",
  "data": {
    "transactionId": "6ax4c39c4964980e578ecb15"
  }
}

Success