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.
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
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.
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.
{"requestId":"239dds16-436d-3R12-ad01-62AEC32acfff","message":"Transaction created successfully","data": {"transactionId":"6ax4c39c4964980e578ecb15" }}