LogoLogo
Useful links
  • Home
  • Product guides
  • API
  • SDKs
  • Overview
  • CORE API
    • Authentication
    • Available resources
      • Transaction
      • Onboarding
      • Profile
      • Synchronous services
        • OCR Sync
        • Basic Data Sync (Individual)
    • Transaction details
      • Services
        • Document OCR
        • Documentscopy
        • Face Liveness
        • Facematch
        • Facial Biometrics
        • Private Faceset
        • Shared Faceset
        • Document Liveness
      • Background check
        • Data structure
        • KYC
          • Driver
          • Financial
          • Labor
          • Register data
          • Relationships
          • Risk
        • KYB
          • Financial
          • Labor
          • Register data
          • Risk
        • Vehicle
          • Register data
      • Validation rules
      • Manual reprovals
    • Webhooks
      • Transaction
      • Profile
      • Face authentication
  • MOBILE API
    • Authentication
    • Available resources
      • Face liveness (deprecated)
      • Face registration (deprecated)
      • Face authentication (deprecated)
    • Response signature
  • GLOBAL API
    • Authentication
    • Available resources
      • Services
        • Company search
        • Company record
        • Basic Data Sync (Individual)
        • Sanctions
      • Orchestrations
        • Transactions
          • Services
            • KYB
              • Credit Report
              • Business Identity
            • KYC
              • Adverse Media
              • PEPs
              • Sanctions
              • Warnings
              • Global identity verification
              • Global identity double verification
            • DOC ID
              • Global Document Verification
      • Onboardings
        • Links
    • Webhooks
  • SMART AUTH API
    • Authentication
    • Available resources
      • Authentications
      • Create identity
  • Joint resolution 6 API
    • Authentication
    • Available resources
      • Suspected fraud creation
      • Suspected fraud query
      • Suspected fraud update
      • Suspected fraud deletion
    • Using mTLS
    • Changelog
LogoLogo

2025 © Caf. - All rights reserved

On this page
  1. GLOBAL API
  2. Available resources
  3. Orchestrations

Transactions

Last updated 2 months ago

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.

Update transaction manual reviews

patch

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

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
Responses
200
Success
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Transaction not found
application/json
500
Internal Server Error
application/json
patch
PATCH /v1/orchestrations/transactions/{transactionId}/manual-reviews HTTP/1.1
Host: api.public.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "reviews": [
    {
      "id": "64b691668251ce3fd54fJ0t4",
      "type": "RULE",
      "status": "REPROVED"
    }
  ]
}
{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "Transaction reviewed successfully",
  "data": {
    "transactionId": "6ax4c39c4964980e578ecb15"
  }
}
  • POSTCreate transactions
  • GETList transactions
  • GETGet transaction
  • PATCHUpdate transaction manual reviews

Create transactions

post

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

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
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"}
metadataobjectOptional

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

Responses
201
Success
application/json
400
Invalid provided body
application/json
401
Invalid token
application/json
403
The token does not have permission to access this resource
application/json
404
Provided workflow not found
application/json
500
Internal server error
application/json
post
POST /v1/orchestrations/transactions HTTP/1.1
Host: api.public.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 400

{
  "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"
  },
  "files": [
    {
      "type": "SELFIE",
      "data": "string"
    },
    {
      "type": "FRONT",
      "data": "string"
    },
    {
      "type": "BACK",
      "data": "string"
    }
  ],
  "metadata": {}
}
{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "Transaction created successfully",
  "data": {
    "transactionId": "6ax4c39c4964980e578ecb15"
  }
}

List transactions

get

Get your transaction list summarized with pagination and filters.

Permission required: Transactions read

Query parameters
startCreatedDatestring · dateOptional

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

endCreatedDatestring · dateOptional

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

statusstring · enumOptional

Status is used for filtering transactions with the same status.

Possible values:
workflowIdstringOptional

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

limitnumber · min: 1 · max: 10Optional

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

Default: 10
orderstring · enumOptional

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

Default: descPossible values:
cursorstringOptional

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

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

Default: nextPossible values:
Header parameters
AuthorizationstringRequired

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

Example: Bearer YOUR_TOKEN
Responses
200
Success
application/json
400
Invalid query parameter
application/json
401
Invalid token
application/json
403
The token does not have permission to access this resource
application/json
500
Internal server error
application/json
get

Get transaction

get

Retrieve the result data of a transaction.

Permission required: Transactions read

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
200
Successful operation
application/json
400
Invalid provided id
application/json
401
Invalid token
application/json
403
The token does not have permission to access this resource
application/json
404
Transaction not found
application/json
500
Internal server error
application/json
get
GET /v1/orchestrations/transactions/{transactionId} HTTP/1.1
Host: api.public.caf.io
Authorization: text
Accept: */*
{
  "requestId": "239dds16-436d-3R12-ad01-62AEC32acfff",
  "message": "Transaction retrieved successfully",
  "data": {
    "id": "26J0T49d250224f35ee72478",
    "status": "APPROVED",
    "createdAt": "2024-05-15T14:13:14.855Z",
    "updatedAt": "2024-05-15T14:13:14.855Z",
    "workflowId": "66J0T49d250224f35ee72478",
    "sections": {
      "globalIdentityVerifications": {
        "data": {
          "detailList": "",
          "adaptation": "0",
          "messages": [
            {
              "value": "Identity could not be verified with service AddressLoq for country BR",
              "code": "WV-AddressLoq-BR"
            }
          ],
          "detailCode": "WS-9603782.2024.4.15.14.13.43.676",
          "query": {
            "options": "identityverify;messageverbose;debug"
          },
          "reliability": "10"
        },
        "statusCode": "01",
        "message": "Successfully",
        "query": {}
      }
    },
    "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"
      }
    ],
    "metadata": {
      "externalId": "customerIdXX989"
    },
    "validations": [
      {
        "ruleId": "66j0t4a33c7bd6f580dfa21e",
        "ruleName": "Good match - reliability 10 1x1 novo",
        "status": "APPROVED",
        "createdAt": "2024-05-15T14:13:14.855Z"
      }
    ]
  }
}
GET /v1/orchestrations/transactions HTTP/1.1
Host: api.public.caf.io
Authorization: text
Accept: */*
{
  "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"
  }
}