Transactions
Last updated
Useful links
Last updated
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.
Retrieve the result data of a transaction.
Permission required: Transactions read
Transaction unique identifier. It must be a valid id.
Your access token. See more in the 'Authentication' topic of this section.
Bearer YOUR_TOKENThis 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
Your access token. See more in the 'Authentication' topic of this section.
Bearer YOUR_TOKENWorkflow unique identifier. It is created on the Trust platform, and you can access it there to get this identifier.
6644cerd257785f35ee70592Person 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.
{"birthDate":"string","dateFormat":"dd/MM/yyyy","name":"string","phoneNumber":"string","address":"string","nationalId":"string","zipCode":"string","countryCode":"MX","creditReportId":"string","businessIdentityId":"string"}Free to add any kind of attribute, ideal for linking IDs or other information in the transaction.
Get your transaction list summarized with pagination and filters.
Permission required: Transactions read
It is considered for filtering transactions created from this date on. Format date must be ISO 8601.
It is considered for filtering transactions created until this date. Format date must be ISO 8601.
Status is used for filtering transactions with the same status.
Workflow unique identifier. It is created on the Trust platform, and you can access it there to get this identifier.
It is used to set how many records can be returned in the response, from 1 to 10. The default value is 10.
10Used to define transaction sort order according to its creation time. The default is descending.
descPossible values: 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.
Used for pagination. Indicates whether the page after the provided cursor or before it should be returned. The default value is next.
nextPossible values: Your access token. See more in the 'Authentication' topic of this section.
Bearer YOUR_TOKENUpdate 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
Transaction unique identifier. It must be a valid id.
Customer access token. See more in the 'Authentication' topic of this section.
Bearer YOUR_TOKEN