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.

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

POSThttps://api.public.caf.io/v1/orchestrations/transactions

Header parameters

Body

workflowId*string

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

Example: "6644cerd257785f35ee70592"

parameters*object

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.

filesarray of object

List of files to be analyzed.

metadataobject

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

Response

Success

Body

requestId*string

Request unique identifier.

Example: "239dds16-436d-3R12-ad01-62AEC32acfff"

message*string

Success message.

Example: "Transaction created successfully"

data*object

Response data.

Request

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "workflowId": "6644cerd257785f35ee70592",
      "parameters": {
        "birthDate": "string",
        "dateFormat": "dd/MM/yyyy",
        "name": "string",
        "phoneNumber": "string",
        "address": "string",
        "nationalId": "string",
        "zipCode": "string",
        "countryCode": "MX",
        "creditReportId": "string",
        "businessIdentityId": "string"
      }
    }),
});
const data = await response.json();

Response

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

List transactions

Get your transaction list summarized with pagination and filters.

Permission required: Transactions read

GEThttps://api.public.caf.io/v1/orchestrations/transactions

Query parameters

Header parameters

Response

Success

Body

requestId*string

Request unique identifier.

Example: "239dds16-436d-3R12-ad01-62AEC32acfff"

message*string

Success message.

Example: "List transactions successfully"

data*object

Response data.

pagination*object

Request

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

Response

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

Get transaction

Retrieve the result data of a transaction.

Permission required: Transactions read

GEThttps://api.public.caf.io/v1/orchestrations/transactions/{transactionId}

Path parameters

transactionId*string

Transaction unique identifier. It must be a valid id.

Header parameters

Response

Successful operation

Body

requestId*string

Request unique identifier.

Example: "239dds16-436d-3R12-ad01-62AEC32acfff"

message*string

Success message.

Example: "Transaction retrieved successfully"

data*object

Response data.

Request

Response

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

PATCHhttps://api.public.caf.io/v1/orchestrations/transactions/{transactionId}/manual-reviews

Path parameters

transactionId*string

Transaction unique identifier. It must be a valid id.

Header parameters

Body

reviewsarray of object

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

Response

Success

Body

requestId*string

Request unique identifier.

Example: "239dds16-436d-3R12-ad01-62AEC32acfff"

message*string

Success message.

Example: "Transaction reviewed successfully"

data*object

Response data.

Request

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions/{transactionId}/manual-reviews', {
    method: 'PATCH',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Last updated 7 months ago

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.

Permission required: Transactions create

POSThttps://api.public.caf.io/v1/orchestrations/transactions

const response = await fetch('https://api.public.caf.io/v1/orchestrations/transactions', { method: 'POST', headers: { "Authorization": "text", "Content-Type": "application/json" }, body: JSON.stringify({ "workflowId": "6644cerd257785f35ee70592", "parameters": { "birthDate": "string", "dateFormat": "dd/MM/yyyy", "name": "string", "phoneNumber": "string", "address": "string", "nationalId": "string", "zipCode": "string", "countryCode": "MX", "creditReportId": "string", "businessIdentityId": "string" } }), }); const data = await response.json();