/transactions endpoint allows you to operate on the Transaction entity.
In order to pass the payload of a transaction to Traxionright and verify the transaction, you will need to call this endpoint with the transaction payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.
\nHere are some of the most used payload fields explained (you can find the full payload schema below with 1 line descriptions):
\ntype: Type of transaction (Ex: WITHDRAWAL, DEPOSIT, TRANSFER etc).
transactionId - Unique Identifier for the transaction. Traxionright API will generate a transactionId if this field is left empty
timestamp - UNIX timestamp in milliseconds of when the transaction took place
transactionState - The state of the transaction, set to CREATED by default. More details here
originUserId - Unique identifier (if any) of the user who is sending the money. This user must be created within the Traxionright system before using the create a individual user or create a entity user endpoint
destinationUserId - Unique identifier (if any) of the user who is receiving the money. This user must be created within the Traxionright system before using the create a individual user or create a entity user endpoint
originAmountDetails - Details of the amount being sent from the origin
destinationAmountDetails - Details of the amount being received at the destination
originPaymentDetails - Payment details (if any) used at the origin (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.
destinationPaymentDetails - Payment details (if any) used at the destination (ex: CARD, IBAN, WALLET etc). You can click on the dropdown next to the field in the schema below to view all supported payment types.
/transactions endpoint allows you to operate on the Transaction entity.
Calling GET /transactions/{transactionId} will return the entire transaction payload and rule execution results for the transaction with the corresponding transactionId
Unique Transaction Identifier
\n","type":"text/plain"},"type":"any","value":"transactionId","key":"transactionId"}]}},"response":[{"id":"1c0db76f-ad1a-4dad-961f-b5ac7c8d5221","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{authToken}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/transactions/:transactionId","host":["{{baseUrl}}"],"path":["transactions",":transactionId"],"variable":[{"key":"transactionId","value":"transactionId","description":"Unique Transaction Identifier"}]},"description":"### GET Transactions\n\n`/transactions` endpoint allows you to operate on the [Transaction entity](/guides/overview/entities#transaction).\n\nCalling `GET /transactions/{transactionId}` will return the entire transaction payload and rule execution results for the transaction with the corresponding `transactionId`"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"originAmountDetails\": {\n \"transactionAmount\": 35000,\n \"transactionCurrency\": \"PHP\",\n \"country\": \"PH\"\n },\n \"destinationAmountDetails\": {\n \"transactionAmount\": 35000,\n \"transactionCurrency\": \"PHP\",\n \"country\": \"PH\"\n },\n \"type\": \"TRANSFER\",\n \"transactionId\": \"23c94c9e7b5f1107db15a530ea2f54c0\",\n \"transactionState\": \"SUSPENDED\",\n \"isFirstTransaction\": false,\n \"timestamp\": 1733648901229,\n \"originUserId\": \"47b2ed45-971f-4234-b774-40acde4cc44c\",\n \"destinationUserId\": \"d9ecf9c9-1c89-4c14-a74f-c92b3856e857\",\n \"relatedTransactionIds\": [],\n \"productType\": \"Digital\",\n \"originPaymentDetails\": {\n \"method\": \"WALLET\"\n },\n \"destinationPaymentDetails\": {\n \"method\": \"WALLET\"\n },\n \"reference\": \"Intra Transfer\",\n \"executedRules\": [\n {\n \"ruleId\": \"T-2\",\n \"ruleNameAlias\": \"Suspend PHP 30k\",\n \"action\": \"ALLOW\",\n \"status\": \"ACTIVE\",\n \"casePriority\": \"P4\",\n \"executedRules\": [\n {\n \"riskLevel\": \"VERY_HIGH\",\n \"detail\": {\n \"riskLevel\": {\n \"originUser\": \"VERY_HIGH\",\n \"destinationUser\": \"VERY_HIGH\"\n },\n \"data\": {\n \"transaction\": {\n \"origin\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n },\n \"destination\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n }\n },\n \"rule\": {\n \"listAmount\": {\n \"currency\": \"PHP\",\n \"amount\": 30000\n }\n }\n }\n }\n }\n ],\n \"id\": \"674d0add2adf7cb23b161ce0\"\n }\n ],\n \"hitRules\": [\n {\n \"ruleId\": \"T-2\",\n \"ruleNameAlias\": \"Suspend PHP 30k\",\n \"action\": \"ALLOW\",\n \"status\": \"ACTIVE\",\n \"casePriority\": \"P4\",\n \"executedRules\": [\n {\n \"riskLevel\": \"VERY_HIGH\",\n \"detail\": {\n \"riskLevel\": {\n \"originUser\": \"VERY_HIGH\",\n \"destinationUser\": \"VERY_HIGH\"\n },\n \"data\": {\n \"transaction\": {\n \"origin\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n },\n \"destination\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n }\n },\n \"rule\": {\n \"listAmount\": {\n \"currency\": \"PHP\",\n \"amount\": 30000\n }\n }\n }\n }\n }\n ],\n \"id\": \"674d0add2adf7cb23b161ce0\"\n }\n ],\n \"tags\": [\n {\n \"key\": \"Source\",\n \"value\": \"API Docs Tester\"\n }\n ],\n \"riskScoreDetails\": {\n \"trsScore\": \"0\",\n \"trsRiskLevel\": \"VERY_HIGH\",\n \"originUserOrsRiskScore\": \"0\",\n \"originUserOrsRiskLevel\": \"VERY_LOW\",\n \"destinationUserOrsRiskScore\": \"0\",\n \"destinationUserOrsRiskLevel\": \"VERY_LOW\"\n },\n \"status\": \"SUSPEND\",\n \"originUserDetail\": {\n \"legalEntity\": {\n \"companyGeneralDetails\": {\n \"businessIndustry\": [],\n \"mainProductsServicesSold\": []\n }\n },\n \"userDetails\": {\n \"name\": {\n \"firstName\": \"Danny\",\n \"middleName\": \"Nancy\",\n \"lastName\": \"Anderson\"\n },\n \"dateOfBirth\": \"1994-01-21\",\n \"countryOfResidence\": \"EE\",\n \"countryOfNationality\": \"FR\"\n },\n \"contactDetails\": {\n \"emailIds\": [\n \"gregory82@example.com\"\n ],\n \"contactNumbers\": [\n \"690.518.4303\"\n ],\n \"websites\": [\n \"http://www.page.com/\"\n ],\n \"addresses\": [\n {\n \"addressLines\": [\n \"363 Johnson Crescent\"\n ],\n \"postcode\": \"19499\",\n \"city\": \"New Shane\",\n \"state\": \"Maryland\",\n \"country\": \"Colombia\",\n \"tags\": [\n {\n \"key\": \"forward\",\n \"value\": \"small\",\n \"_id\": \"675559e9b1d3a7ca74dc4aac\",\n \"id\": \"675559e9b1d3a7ca74dc4aac\"\n }\n ],\n \"_id\": \"675559e9b1d3a7ca74dc4aab\",\n \"id\": \"675559e9b1d3a7ca74dc4aab\"\n }\n ],\n \"faxNumbers\": []\n },\n \"employmentDetails\": {\n \"businessIndustry\": []\n },\n \"userStateDetails\": {\n \"state\": \"CREATED\",\n \"reason\": \"\"\n },\n \"kycStatusDetails\": {\n \"status\": \"NOT_STARTED\",\n \"reason\": \"\"\n },\n \"userId\": \"47b2ed45-971f-4234-b774-40acde4cc44c\",\n \"createdTimestamp\": 1733646618204,\n \"updatedTimestamp\": 1733646825456,\n \"userType\": \"INDIVIDUAL\",\n \"legalDocuments\": [\n {\n \"documentType\": \"passport\",\n \"documentNumber\": \"vcj-758173\",\n \"documentIssuedDate\": 1702089666204,\n \"documentExpirationDate\": 1765203570204,\n \"documentIssuedCountry\": \"IT\",\n \"_id\": \"675559e9b1d3a7ca74dc4aaa\",\n \"tags\": [],\n \"id\": \"675559e9b1d3a7ca74dc4aaa\"\n }\n ],\n \"reasonForAccountOpening\": [\n \"INVESTMENT\"\n ],\n \"sourceOfFunds\": [\n \"SAVINGS\"\n ],\n \"tags\": [\n {\n \"key\": \"addedBy\",\n \"value\": \"API Docs Tester\",\n \"_id\": \"675559e9b1d3a7ca74dc4aad\",\n \"id\": \"675559e9b1d3a7ca74dc4aad\"\n }\n ],\n \"deleted\": false,\n \"pepStatus\": [],\n \"createdAt\": \"2024-12-08T08:33:45.467Z\",\n \"updatedAt\": \"2024-12-08T08:33:45.467Z\",\n \"id\": \"675559e9b1d3a7ca74dc4aa9\"\n },\n \"destinationUserDetail\": {\n \"legalEntity\": {\n \"companyGeneralDetails\": {\n \"businessIndustry\": [],\n \"mainProductsServicesSold\": []\n }\n },\n \"userDetails\": {\n \"name\": {\n \"firstName\": \"Alexandra\",\n \"middleName\": \"Evelyn\",\n \"lastName\": \"Trujillo\"\n },\n \"dateOfBirth\": \"1953-01-29\",\n \"countryOfResidence\": \"BO\",\n \"countryOfNationality\": \"NA\"\n },\n \"contactDetails\": {\n \"emailIds\": [\n \"tthomas@example.org\"\n ],\n \"contactNumbers\": [\n \"(327)222-5144x0804\"\n ],\n \"websites\": [\n \"http://www.hernandez-juarez.org/\"\n ],\n \"addresses\": [\n {\n \"addressLines\": [\n \"19004 Phillips Loop Suite 144\"\n ],\n \"postcode\": \"87874\",\n \"city\": \"Lewisborough\",\n \"state\": \"Michigan\",\n \"country\": \"Barbados\",\n \"tags\": [\n {\n \"key\": \"size\",\n \"value\": \"paper\",\n \"_id\": \"67555110f0b28279fccec2d4\",\n \"id\": \"67555110f0b28279fccec2d4\"\n }\n ],\n \"_id\": \"67555110f0b28279fccec2d3\",\n \"id\": \"67555110f0b28279fccec2d3\"\n }\n ],\n \"faxNumbers\": []\n },\n \"employmentDetails\": {\n \"businessIndustry\": []\n },\n \"userStateDetails\": {\n \"state\": \"CREATED\",\n \"reason\": \"\"\n },\n \"kycStatusDetails\": {\n \"status\": \"NOT_STARTED\",\n \"reason\": \"\"\n },\n \"userId\": \"d9ecf9c9-1c89-4c14-a74f-c92b3856e857\",\n \"createdTimestamp\": 1733622417452,\n \"updatedTimestamp\": 1733644560346,\n \"userType\": \"INDIVIDUAL\",\n \"legalDocuments\": [\n {\n \"documentType\": \"passport\",\n \"documentNumber\": \"ozL-406873\",\n \"documentIssuedDate\": 1702065465454,\n \"documentExpirationDate\": 1765179369454,\n \"documentIssuedCountry\": \"GY\",\n \"_id\": \"67555110f0b28279fccec2d2\",\n \"tags\": [],\n \"id\": \"67555110f0b28279fccec2d2\"\n }\n ],\n \"reasonForAccountOpening\": [\n \"INVESTMENT\"\n ],\n \"sourceOfFunds\": [\n \"SAVINGS\"\n ],\n \"tags\": [\n {\n \"key\": \"Source\",\n \"value\": \"API Docs Tester\",\n \"_id\": \"67555110f0b28279fccec2d5\",\n \"id\": \"67555110f0b28279fccec2d5\"\n }\n ],\n \"deleted\": false,\n \"pepStatus\": [],\n \"createdAt\": \"2024-12-08T07:56:00.355Z\",\n \"updatedAt\": \"2024-12-08T07:56:00.355Z\",\n \"id\": \"67555110f0b28279fccec2d1\"\n }\n}"}],"_postman_id":"e43aebc3-17db-42c1-8a4d-5752b87b9ef5"}],"id":"e3b1a762-78b0-4792-a3ef-6b2fa12ca8fa","_postman_id":"e3b1a762-78b0-4792-a3ef-6b2fa12ca8fa","description":""},{"name":"Transaction Events","item":[{"name":"Create a Transaction Event","id":"0d6f8b80-140e-451f-aefc-7311a20377a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timestamp\": 1733649554849, // Required\n \"transactionId\": \"23c94c9e7b5f1107db15a530ea2f54c0\", // Required\n \"eventId\": \"c08b6ccdee2be0e16ab0a3218b821bf7\",\n \"eventDescription\": \"Transaction Successful\",\n \"reason\": \"Transaction Successful\",\n \"updatedTransactionAttributes\": { \n \"transactionState\": \"SUCCESSFUL\" // Required | Options: CREATED / PROCESSING / SENT / EXPIRED / DECLINED / SUSPENDED / REFUNDED / SUCCESSFUL / REVERSED\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/events/transaction","description":"/events/transaction endpoint allows you to operate on the Transaction Events entity.
Transaction events are created after the initial POST /transactions call (which creates a transaction) and are used to:
Update the STATE of the transaction, using the transactionState field and manage the Transaction Lifecycle
Update the transaction details, using the updatedTransactionAttributes field.
\n\nIf you have neither of the above two use cases, you do not need to use transaction events.
\n
Each transaction event needs three mandatory fields:
\ntransactionState - STATE of the transaction -> value is set to CREATED after POST /transactions call
timestamp- the timestamp of when the event was created or occured in your system
transactionId - The ID of the transaction for which this event is generated.
In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.
/events/transaction endpoint allows you to operate on the Transaction Events entity..
You can retrieve any transaction event you created using the POST Transaction Events call.
\n","urlObject":{"path":["events","transaction",":eventId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"762536d9-80df-4d93-ad1b-4544b97d3810","description":{"content":"Unique Transaction Identifier
\n","type":"text/plain"},"type":"any","value":"eventId","key":"eventId"}]}},"response":[{"id":"c3e0b67d-8805-40ff-a037-745fd569a4b7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{authToken}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/events/transaction/:eventId","host":["{{baseUrl}}"],"path":["events","transaction",":eventId"],"variable":[{"key":"eventId","value":"eventId","description":"Unique Transaction Identifier"}]},"description":"### GET Transaction Events\n\n`/events/transaction` endpoint allows you to operate on the [Transaction Events entity.](/guides/overview/entities#transaction-event).\n\nYou can retrieve any transaction event you created using the [POST Transaction Events](/api-reference/api-reference/transaction-events/create) call."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"updatedTransactionAttributes\": {\n \"transactionState\": \"SUCCESSFUL\",\n \"relatedTransactionIds\": [],\n \"tags\": []\n },\n \"timestamp\": 1733649554849,\n \"transactionId\": \"23c94c9e7b5f1107db15a530ea2f54c0\",\n \"eventId\": \"c08b6ccdee2be0e16ab0a3218b821bf7\",\n \"eventDescription\": \"Transaction Successful\",\n \"reason\": \"Transaction Successful\",\n \"executedRules\": [\n {\n \"ruleId\": \"T-2\",\n \"ruleNameAlias\": \"Suspend PHP 30k\",\n \"action\": \"ALLOW\",\n \"status\": \"ACTIVE\",\n \"casePriority\": \"P4\",\n \"executedRules\": [\n {\n \"riskLevel\": \"VERY_HIGH\",\n \"detail\": {\n \"riskLevel\": {\n \"originUser\": \"VERY_HIGH\",\n \"destinationUser\": \"VERY_HIGH\"\n },\n \"data\": {\n \"transaction\": {\n \"origin\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n },\n \"destination\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n }\n },\n \"rule\": {\n \"listAmount\": {\n \"currency\": \"PHP\",\n \"amount\": 30000\n }\n }\n }\n }\n }\n ],\n \"id\": \"674d0add2adf7cb23b161ce0\"\n }\n ],\n \"hitRules\": [\n {\n \"ruleId\": \"T-2\",\n \"ruleNameAlias\": \"Suspend PHP 30k\",\n \"action\": \"ALLOW\",\n \"status\": \"ACTIVE\",\n \"casePriority\": \"P4\",\n \"executedRules\": [\n {\n \"riskLevel\": \"VERY_HIGH\",\n \"detail\": {\n \"riskLevel\": {\n \"originUser\": \"VERY_HIGH\",\n \"destinationUser\": \"VERY_HIGH\"\n },\n \"data\": {\n \"transaction\": {\n \"origin\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n },\n \"destination\": {\n \"currency\": \"PHP\",\n \"amount\": 35000\n }\n },\n \"rule\": {\n \"listAmount\": {\n \"currency\": \"PHP\",\n \"amount\": 30000\n }\n }\n }\n }\n }\n ],\n \"id\": \"674d0add2adf7cb23b161ce0\"\n }\n ],\n \"riskScoreDetails\": {\n \"trsScore\": \"0\",\n \"trsRiskLevel\": \"VERY_HIGH\",\n \"originUserOrsRiskScore\": \"0\",\n \"originUserOrsRiskLevel\": \"VERY_LOW\",\n \"destinationUserOrsRiskScore\": \"0\",\n \"destinationUserOrsRiskLevel\": \"VERY_LOW\"\n },\n \"status\": \"SUSPEND\"\n}"}],"_postman_id":"a3a63838-a255-47a3-a6f1-980ff1cc1d49"}],"id":"04cd9334-86c7-46e8-880d-4b964e0fb169","_postman_id":"04cd9334-86c7-46e8-880d-4b964e0fb169","description":""},{"name":"Individual Users","item":[{"name":"Create an Individual Users","id":"4515c92f-4219-4be2-a479-19c39b6958cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"userId\": \"47b2ed45-971f-4234-b774-40acde4cc44c\", // Required\n \"createdTimestamp\": 1733646618204, // Required\n \"userType\": \"INDIVIDUAL\", // Required\n \"userDetails\": {\n \"name\": {\n \"firstName\": \"Danny\",\n \"middleName\": \"Nancy\",\n \"lastName\": \"Anderson\"\n },\n \"dateOfBirth\": \"1994-01-21\",\n \"countryOfResidence\": \"EE\",\n \"countryOfNationality\": \"FR\"\n },\n \"legalDocuments\": [\n {\n \"documentType\": \"passport\",\n \"documentNumber\": \"vcj-758173\",\n \"documentIssuedDate\": 1702089666204,\n \"documentExpirationDate\": 1765203570204,\n \"documentIssuedCountry\": \"IT\"\n }\n ],\n \"reasonForAccountOpening\": [\n \"INVESTMENT\"\n ],\n \"sourceOfFunds\": [\n \"SAVINGS\"\n ],\n \"userStateDetails\": {\n \"state\": \"CREATED\",\n \"reason\": \"\"\n },\n \"kycStatusDetails\": {\n \"status\": \"NOT_STARTED\",\n \"reason\": \"\"\n },\n \"contactDetails\": {\n \"emailIds\": [\n \"gregory82@example.com\"\n ],\n \"contactNumbers\": [\n \"690.518.4303\"\n ],\n \"websites\": [\n \"http://www.page.com/\"\n ],\n \"addresses\": [\n {\n \"addressLines\": [\n \"363 Johnson Crescent\"\n ],\n \"postcode\": \"19499\",\n \"city\": \"New Shane\",\n \"state\": \"Maryland\",\n \"country\": \"Colombia\",\n \"addressType\": \"Other\",\n \"tags\": [\n {\n \"key\": \"forward\",\n \"value\": \"small\"\n }\n ]\n }\n ]\n },\n \"tags\": [\n {\n \"key\": \"addedBy\",\n \"value\": \"API Docs Tester\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/individual/users","description":"/individual/users endpoint allows you to operate on the Individual user.
In order to pass the payload of a User to Traxionright and verify the User, you will need to call this endpoint with the User payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.
\nEach individual user needs two mandatory fields:
\nuserId - Unique identifier for the user
createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system
/individual/users endpoint allows you to operate on the Individual User.
Calling GET /individual/users/{userId} will return the entire user payload and rule execution results for the user with the corresponding userId
/entity/users endpoint allows you to operate on the Entity user.
In order to pass the payload of a User to Traxionright and verify the User, you will need to call this endpoint with the User payload. Not all fields are mandatory, you will only need to pass in the fields that you have and are relevant for your compliance setup.
\nEach entity user needs three mandatory fields:
\nuserId - Unique identifier for the user
legalEntity - Details of the entity legal entity (CompanyGeneralDetails, FinancialDetails etc) - only legalNamein CompanyGeneralDetails is mandatory
createdTimestamp - UNIX timestamp in milliseconds for when the User is created in your system
/entity/users endpoint allows you to operate on the Entity User.
Calling GET /entity/users/{userId} will return the entire User payload and rule execution results for the User with the corresponding userId
/events/individual/user endpoint allows you to operate on the Individual User Events.
User events are created after the initial POST /individual/users call (which creates a user) and are used to:
Update the STATE and KYC Status of the user, using the userStateDetails or kycStatusDetails field
Update the user details, using the updatedAttributes field.
\n\nIf you have neither of the above two use cases, you do not need to use user events.
\n
Each user event needs three mandatory fields:
\ntimestamp- the timestamp of when the event was created or occured in your system
userId - The ID of the transaction for which this event is generated.
In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.
You can retrieve any individual user event you created using the POST Individual User Events call.
\n","urlObject":{"path":["events","individual","user",":eventId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"Unique Consumer User Event Identifier
\n","type":"text/plain"},"type":"any","value":"eventId","key":"eventId"}]}},"response":[{"id":"81999730-d582-4963-b1a9-e2d8dad4fdc5","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{authToken}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/events/individual/user/:eventId","host":["{{baseUrl}}"],"path":["events","individual","user",":eventId"],"variable":[{"key":"eventId","value":"675506854e539b56a651b4d1","description":"Unique Consumer User Event Identifier"}]},"description":"### GET a Consumer User Event\n\nYou can retrieve any consumer user event you created using the [POST Consumer User Events](/api-reference/api-reference/consumer-user-events/create) call."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"updatedAttributes\": {\n \"legalEntity\": {\n \"companyGeneralDetails\": {\n \"businessIndustry\": [],\n \"mainProductsServicesSold\": []\n }\n },\n \"contactDetails\": {\n \"emailIds\": [],\n \"contactNumbers\": [],\n \"faxNumbers\": [],\n \"websites\": [],\n \"addresses\": []\n },\n \"employmentDetails\": {\n \"businessIndustry\": []\n },\n \"kycStatusDetails\": {\n \"status\": \"SUCCESSFUL\",\n \"reason\": \"\"\n },\n \"legalDocuments\": [],\n \"reasonForAccountOpening\": [],\n \"sourceOfFunds\": [],\n \"pepStatus\": [],\n \"tags\": [],\n \"userType\": \"INDIVIDUAL\"\n },\n \"timestamp\": 1733652039456,\n \"eventId\": \"d354c59b09343f018b0d7f5fe888225e787ac3ad\",\n \"userId\": \"47b2ed45-971f-4234-b774-40acde4cc44c\",\n \"reason\": \"Update KYC Status\",\n \"eventDescription\": \"Update KYC Status\",\n \"updatedAt\": \"2024-12-08T10:00:54.495Z\",\n \"tags\": [],\n \"pepStatus\": [],\n \"legalDocuments\": [],\n \"executedRules\": [],\n \"hitRules\": [],\n \"riskScoreDetails\": {\n \"irsRiskScore\": 0,\n \"irsRiskLevel\": \"MEDIUM\",\n \"orsRiskScore\": 0,\n \"orsRiskLevel\": \"MEDIUM\"\n }\n}"}],"_postman_id":"1b4da978-acd9-44b8-a82a-7e22d3f0a3d4"}],"id":"bdae2f9b-da72-49a6-b4c9-34110c6117ca","_postman_id":"bdae2f9b-da72-49a6-b4c9-34110c6117ca","description":""},{"name":"Entity User Events","item":[{"name":"Create an Entity User Event","id":"bd2a66a1-5b69-4e0f-b690-a3f64af2b712","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timestamp\": 1733652495364, // Required\n \"userId\": \"ef43e47a-7f3e-485f-b6ab-402949bf5ea5\", // Required\n \"eventId\": \"ea78ebf380811839d27750bf85c9cb6e\",\n \"reason\": \"Update Source of Fund\",\n \"eventDescription\": \"Update Source of Fund\",\n \"updatedAttributes\": {\n \"sourceOfFunds\": [\n \"Investment\" // Options: PERSONAL SAVINGS / SALARY / INHERITANCE / SELLING ASSETS / BUSINESS LOAN / CAPITAL RAISING / GRANTS / INVESTMENTS / RETAINED EARNINGS / VENTURE CAPITAL / ANGEL INVESTORS / BUSINESS OWNERSHIP / BUSINESS PROFITS / CROWDFUNDING / FAMILY AND FRIENDS / GOVERNMENT / OWNER CONTRIBUTIONS / STOCK MARKET\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/events/entity/user","description":"/events/entity/user endpoint allows you to operate on the Entity User Events.
User events are created after the initial POST /entity/users call (which creates a user) and are used to:
Update the STATE and KYC Status of the user, using the userStateDetails or kycStatusDetails field
Update the user details, using the updatedAttributes field.
\n\nIf you have neither of the above two use cases, you do not need to use user events.
\n
Each user event needs three mandatory fields:
\ntimestamp- the timestamp of when the event was created or occured in your system
userId - The ID of the transaction for which this event is generated.
In order to make individual events retrievable, you also need to pass in a unique eventId to the request body.
You can retrieve any entitiy user event you created using the POST Entity User Events call.
\n","urlObject":{"path":["events","entity","user",":eventId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"Unique Business User Event Identifier
\n","type":"text/plain"},"type":"any","value":"eventId","key":"eventId"}]}},"response":[{"id":"bbdeb834-12b6-43b5-a262-dc0bc0da7260","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{authToken}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/events/entity/user/:eventId","host":["{{baseUrl}}"],"path":["events","entity","user",":eventId"],"variable":[{"key":"eventId","value":"eventId","description":"Unique Business User Event Identifier"}]},"description":"### GET a Business User Event\n\nYou can retrieve any business user event you created using the [POST Business User Events](/api-reference/api-reference/business-user-events/create) call."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"updatedAttributes\": {\n \"legalEntity\": {\n \"companyGeneralDetails\": {\n \"businessIndustry\": [],\n \"mainProductsServicesSold\": []\n }\n },\n \"contactDetails\": {\n \"emailIds\": [],\n \"contactNumbers\": [],\n \"faxNumbers\": [],\n \"websites\": [],\n \"addresses\": []\n },\n \"employmentDetails\": {\n \"businessIndustry\": []\n },\n \"sourceOfFunds\": [\n \"Investment\"\n ],\n \"legalDocuments\": [],\n \"reasonForAccountOpening\": [],\n \"pepStatus\": [],\n \"tags\": [],\n \"userType\": \"ENTITY\"\n },\n \"timestamp\": 1733652495364,\n \"eventId\": \"ea78ebf380811839d27750bf85c9cb6e\",\n \"userId\": \"ef43e47a-7f3e-485f-b6ab-402949bf5ea5\",\n \"reason\": \"Update Source of Fund\",\n \"eventDescription\": \"Update Source of Fund\",\n \"updatedAt\": \"2024-12-08T10:08:35.147Z\",\n \"tags\": [],\n \"pepStatus\": [],\n \"legalDocuments\": [],\n \"executedRules\": [],\n \"hitRules\": [],\n \"riskScoreDetails\": {\n \"irsRiskScore\": 0,\n \"irsRiskLevel\": \"MEDIUM\",\n \"orsRiskScore\": 0,\n \"orsRiskLevel\": \"MEDIUM\"\n }\n}"}],"_postman_id":"3e2123b8-197e-4bae-a00c-f050d521954b"}],"id":"b5acc76a-e064-4548-b917-29cf6cc2a9ee","_postman_id":"b5acc76a-e064-4548-b917-29cf6cc2a9ee","description":""}],"id":"45fbce9a-d02f-4a2a-acec-d7b868f8e18a","_postman_id":"45fbce9a-d02f-4a2a-acec-d7b868f8e18a","description":""},{"name":"Management","item":[{"name":"Rule","item":[{"name":"Instance","item":[{"name":"Rule Instance - List","id":"05891bcf-95be-4c6a-a576-4537b6e70093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/rule-instances","urlObject":{"path":["management","rule-instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05891bcf-95be-4c6a-a576-4537b6e70093"},{"name":"Rule Instance - Create","id":"8f97e5a7-a242-4117-9c65-eaf22f4241bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ruleId\": \"\", // string Optional\n \"filters\": [], // map from strings to any Optional (Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.)\n \"ruleNameAlias\": \"\", // string Optional\n \"riskLevelParameters\": { // object Optional\n \"VERY_HIGH\": \"\", // map from strings to any Required \n \"HIGH\": \"\", // map from strings to any Required \n \"MEDIUM\": \"\", // map from strings to any Required \n \"LOW\": \"\", // map from strings to any Required \n \"VERY_LOW\": \"\" // map from strings to any Required \n },\n \"action\": \"\", // enum Optional (ALLOW, FLAG, BLOCK, SUSPEND)\n \"riskLevelActions\": { // object Optional\n \"VERY_HIGH\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"HIGH\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"MEDIUM\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"LOW\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"VERY_LOW\": \"\" // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n },\n \"triggersOnHit\": { // object Optional\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Optional (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"riskLevelsTriggersOnHit\": { // object Optional\n \"VERY_HIGH\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"HIGH\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"MEDIUM\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"LOW\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"VERY_LOW\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n }\n },\n \"status\": \"\", // enum Optional (ACTIVE, INACTIVE)\n \"casePriority\": \"\" // enum Optional (P1, P2, P3, P4) \n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/rule-instances","urlObject":{"path":["management","rule-instances"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f97e5a7-a242-4117-9c65-eaf22f4241bf"},{"name":"Rule Instance - Update","id":"0007b352-b9c0-4f16-960c-e1f9fb75c015","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"ruleId\": \"\", // string Optional\n \"filters\": [], // map from strings to anyOptional (Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.)\n \"ruleNameAlias\": \"\", // string Optional\n \"riskLevelParameters\": { // object Optional\n \"VERY_HIGH\": \"\", // map from strings to any Required \n \"HIGH\": \"\", // map from strings to any Required \n \"MEDIUM\": \"\", // map from strings to any Required \n \"LOW\": \"\", // map from strings to any Required \n \"VERY_LOW\": \"\" // map from strings to any Required \n },\n \"action\": \"\", // enum Optional (ALLOW, FLAG, BLOCK, SUSPEND)\n \"riskLevelActions\": { // object Optional\n \"VERY_HIGH\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"HIGH\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"MEDIUM\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"LOW\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"VERY_LOW\": \"\" // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n },\n \"triggersOnHit\": { // object Optional\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Optional (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"riskLevelsTriggersOnHit\": { // object Optional\n \"VERY_HIGH\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"HIGH\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"MEDIUM\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"LOW\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n },\n \"VERY_LOW\": { // object Required\n \"usersToCheck\": \"\", // enum Required (ALL, ORIGIN, DESTINATION)\n \"userStateDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"state\": \"\", // enum Required (UNACCEPTABLE, TERMINATED, ACTIVE, DORMANT, CREATED, SUSPENDED, BLOCKED)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n },\n \"kycStatusDetails\": { // object Optional\n \"reason\": \"\", // string Required\n \"status\": \"\", // enum Required (SUCCESSFUL, FAILED, NOT_STARTED, IN_PROGRESS, EXPIRED, NEW, CANCELLED, MANUAL_REVIEW, EDD_IN_PROGRESS)\n \"userId\": \"\", // string Optional\n \"description\": \"\" // string Optional\n }\n }\n },\n \"status\": \"\", // enum Optional (ACTIVE, INACTIVE)\n \"casePriority\": \"\" // enum Optional (P1, P2, P3, P4) \n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/rule-instances/:ruleInstanceId","urlObject":{"path":["management","rule-instances",":ruleInstanceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"05a16fce-8ce5-42d0-a15e-e42d25fe7682","type":"any","value":"","key":"ruleInstanceId"}]}},"response":[],"_postman_id":"0007b352-b9c0-4f16-960c-e1f9fb75c015"},{"name":"Rule Instance - Delete","id":"455a1f57-b27f-45f6-a04d-5ba2b4ff9079","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{baseUrl}}/management/rule-instances/:ruleInstanceId","urlObject":{"path":["management","rule-instances",":ruleInstanceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"9234b70a-26e9-4312-bcde-9f4f5bb5f1fe","type":"any","value":"","key":"ruleInstanceId"}]}},"response":[],"_postman_id":"455a1f57-b27f-45f6-a04d-5ba2b4ff9079"}],"id":"1faee24f-1c36-4090-b4e9-b6ceb2cee63e","_postman_id":"1faee24f-1c36-4090-b4e9-b6ceb2cee63e","description":""},{"name":"Rule - List","id":"7226a3bf-35d8-49a8-9c27-314ff25b1e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/rules","urlObject":{"path":["management","rules"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7226a3bf-35d8-49a8-9c27-314ff25b1e0e"},{"name":"Rule - Get","id":"3f15db8f-5737-4df7-9083-ca4ea17fdbe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/rules/:ruleId","urlObject":{"path":["management","rules",":ruleId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"2150e4dc-2ebe-4365-9f91-8499669e63ed","description":{"content":"string Required
\n","type":"text/plain"},"type":"any","value":"","key":"ruleId"}]}},"response":[],"_postman_id":"3f15db8f-5737-4df7-9083-ca4ea17fdbe3"},{"name":"Rule Filters Schema - Get","id":"e8d75903-8514-4e51-89b9-452c564a1977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/rule-filters-schema","urlObject":{"path":["management","rule-filters-schema"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8d75903-8514-4e51-89b9-452c564a1977"}],"id":"1bfe7bf8-1fa9-4d89-93e8-f6bab576e348","_postman_id":"1bfe7bf8-1fa9-4d89-93e8-f6bab576e348","description":""},{"name":"Case","item":[{"name":"Case - List","id":"e32fa6ca-a2d1-4c75-af04-35ab4bbae42b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/cases?start&pageSize&sortBy&sortOrder&filterCaseStatus&filterPriority&filterCaseSource&filterAfterCreatedTimestamp&filterBeforeCreatedTimestamp","urlObject":{"path":["management","cases"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"string Optional
\n","type":"text/plain"},"key":"start","value":null},{"description":{"content":"double Optional
\n","type":"text/plain"},"key":"pageSize","value":null},{"description":{"content":"enum Optional (createdTimestamp, updatedAt, caseId, priority)
\n","type":"text/plain"},"key":"sortBy","value":null},{"description":{"content":"enum Optional (asc, desc)
\n","type":"text/plain"},"key":"sortOrder","value":null},{"description":{"content":"enum Optional (OPEN, CLOSED, REOPENED, IN_REVIEW, ESCALATED, IN_PROGRESS, ON_HOLD)
\n","type":"text/plain"},"key":"filterCaseStatus","value":null},{"description":{"content":"enum Optional (P1, P2, P3, P4)
\n","type":"text/plain"},"key":"filterPriority","value":null},{"description":{"content":"enum Optional (MANUAL, SYSTEM, EXTERNAL)
\n","type":"text/plain"},"key":"filterCaseSource","value":null},{"description":{"content":"double Optional
\n","type":"text/plain"},"key":"filterAfterCreatedTimestamp","value":null},{"description":{"content":"double Optional
\n","type":"text/plain"},"key":"filterBeforeCreatedTimestamp","value":null}],"variable":[]}},"response":[],"_postman_id":"e32fa6ca-a2d1-4c75-af04-35ab4bbae42b"},{"name":"Case - Create (Need update)","id":"704c6a59-661d-48a9-acd6-2a22e8dfe6c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"caseId\": \"\", //string Required\n \"createdTimestamp\": \"\", // double Required\n \"priority\": \"\", // enum Required (P1, P2, P3, P4)\n \"entityDetails\": { // union Required\n \"type\": \"\", // enum Required (USER, PAYMENT)\n // USER only\n \"userId\": \"\", // string Required \n // PAYMENT only\n \"paymentDetails\": { // union Required\n \"method\": \"\" // enum Required (CARD, GENERIC_BANK_ACCOUNT, IBAN, ACH, SWIFT, MPESA, UPI, WALLET, CHECK)\n // ?????\n },\n \"tags\": {\n \"key\": \"\", // string Required\n \"value\": \"\" // string Required\n },\n \"creationReason\": { // object Optional\n \"reasons\": \"\", // list of strings Required\n \"comment\": \"\", // string Required,\n \"timestamp\": \"\" // double Optional\n },\n \"relatedCases\": \"\", // list of strings Optional,\n \"assignments\": { // list of objects Optional\n \"assigneeEmail\": \"\", // string Required,\n \"assignedByEmail\": \"\", // string Optional,\n \"timestamp\": \"\" // double Optional\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/cases","urlObject":{"path":["management","cases"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"704c6a59-661d-48a9-acd6-2a22e8dfe6c4"},{"name":"Case - Update Status","id":"6cb0e184-6ee9-4374-a8ba-dc6950e38627","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"\", // enum Required (OPEN, CLOSED, REOPENED, IN_PROGRESS, ON_HOLD)\n \"reason\": \"\", // enum Optional (Other, False positive, Documents collected, Transaction Rejected, Transaction Refunded, Suspicious activity reported (SAR), Documents not collected, Investigation completed, Escalated, Fraud, Anti-money laundering, Terrorist financing, User Blacklisted, User Terminated, Internal referral)\n \"otherReason\": \"\", // string Optional\n \"comment\": \"\", // string Optional\n \"files\": { // list of objects Optional\n \"s3Key\": \"\", // string Required\n \"filename\": \"\", // string Required\n \"size\": \"\" // double Required\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/cases/:caseId/statuses","urlObject":{"path":["management","cases",":caseId","statuses"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"7b2867d8-cd0f-416c-83a5-4fe01bc11c4c","description":{"content":"string Required
\n","type":"text/plain"},"type":"any","value":"","key":"caseId"}]}},"response":[],"_postman_id":"6cb0e184-6ee9-4374-a8ba-dc6950e38627"},{"name":"Case - Get","id":"f455ee50-cf23-4e0c-bc0e-f7646b99b32f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/cases/:caseId","urlObject":{"path":["management","cases",":caseId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e4ce9ed5-91c0-4f87-9077-421b11758f00","description":{"content":"string Required
\n","type":"text/plain"},"type":"any","value":"","key":"caseId"}]}},"response":[],"_postman_id":"f455ee50-cf23-4e0c-bc0e-f7646b99b32f"}],"id":"9753cdad-4a96-4765-8c65-b412bf4d83ae","_postman_id":"9753cdad-4a96-4765-8c65-b412bf4d83ae","description":""},{"name":"Alerts","item":[{"name":"Comment (Need update)","item":[],"id":"bc434d54-1644-4148-bbe1-23d4f225f0f4","_postman_id":"bc434d54-1644-4148-bbe1-23d4f225f0f4","description":""},{"name":"Alert - Create","id":"400fe872-f888-45ea-9581-3952d2a5be6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"alertId\": \"\", // string Required\n \"createdTimestamp\": \"\", // double Required\n \"caseId\": \"\", // string Required\n \"priority\": \"\", // enum Required (P1, P2, P3, P4)\n \"entityDetails\": { // union Required\n \"type\": \"\", // enum Required (TRANSACTION, SANCTIONS)\n // TRANSACTION only\n \"transactionIds\": \"\" // list of strings Required \n },\n \"ruleDetails\": { // object Required\n \"id\": \"\", // string Required\n \"name\": \"\", // string Required\n \"action\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"description\": \"\", // string Required\n \"instanceId\": \"\", // string Required\n \"nature\": \"\" // enum Optional (AML, FRAUD, CTF,SCREENING)\n },\n \"tags\": { // list of objects Optional\n \"key\": \"\", // string Required,\n \"value\": \"\" // stringRequired\n },\n \"creationReason\": { // object Optional\n \"reasons\": \"\", // list of strings Required\n \"comment\": \"\", // string Required\n \"timestamp\": \"\" // double Optional\n },\n \"assignments\": { // list of objects Optional\n \"assigneeEmail\": \"\", // string Required\n \"assignedByEmail\": \"\", // string Optional\n \"timestamp\": \"\" // double Optional\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/alerts","urlObject":{"path":["management","alerts"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"400fe872-f888-45ea-9581-3952d2a5be6c"},{"name":"Alert - Update Status","id":"9b8959c2-fb21-4754-88db-f6e75727a0b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"\", // enum Required (OPEN, CLOSED, REOPENED, IN_PROGRESS, ON_HOLD)\n \"reason\": \"\", // enum Optional (Other, False positive, Documents collected, Transaction Rejected, Transaction Refunded, Suspicious activity reported (SAR), Documents not collected, Investigation completed, Escalated, Fraud, Anti-money laundering, Terrorist financing, User Blacklisted, User Terminated, Internal referral) \n \"otherReason\": \"\", // string Optional\n \"comment\": \"\", // string Optional\n \"files\": { // list of objects Optional\n \"s3Key\": \"\", // string Required\n \"filename\": \"\", // string Required\n \"size\": \"\" // double Required\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/alerts/:alertId/statuses","urlObject":{"path":["management","alerts",":alertId","statuses"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"dffbc02e-5049-49bb-a808-6364e3ea212c","description":{"content":"string Required
\n","type":"text/plain"},"type":"any","value":"","key":"alertId"}]}},"response":[],"_postman_id":"9b8959c2-fb21-4754-88db-f6e75727a0b1"},{"name":"Alert - Update","id":"0b3e85dd-5e9d-48c9-99ea-5ec55975d52d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{ \n \"priority\": \"\", // enum Required (P1, P2, P3, P4)\n \"entityDetails\": { // union Required\n \"type\": \"\", // enum Required (TRANSACTION, SANCTIONS)\n // TRANSACTION only\n \"transactionIds\": \"\" // list of strings Required \n },\n \"ruleDetails\": { // object Required\n \"id\": \"\", // string Required\n \"name\": \"\", // string Required\n \"action\": \"\", // enum Required (ALLOW, FLAG, BLOCK, SUSPEND)\n \"description\": \"\", // string Required\n \"instanceId\": \"\", // string Required\n \"nature\": \"\" // enum Optional (AML, FRAUD, CTF,SCREENING)\n },\n \"tags\": { // list of objects Optional\n \"key\": \"\", // string Required,\n \"value\": \"\" // stringRequired\n },\n \"creationReason\": { // object Optional\n \"reasons\": \"\", // list of strings Required\n \"comment\": \"\", // string Required\n \"timestamp\": \"\" // double Optional\n },\n \"assignments\": { // list of objects Optional\n \"assigneeEmail\": \"\", // string Required\n \"assignedByEmail\": \"\", // string Optional\n \"timestamp\": \"\" // double Optional\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/management/alerts/:alertId","urlObject":{"path":["management","alerts",":alertId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"c7b12079-157b-4b69-b4b3-827f00e53a0b","type":"any","value":"","key":"alertId"}]}},"response":[],"_postman_id":"0b3e85dd-5e9d-48c9-99ea-5ec55975d52d"},{"name":"Alert - Get","id":"7818a40d-3e1f-437e-9c10-00ae8bfb28fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/management/alerts/:alertId","urlObject":{"path":["management","alerts",":alertId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"8b1e31f2-2289-4af0-8c61-687ca877210e","type":"any","value":"","key":"alertId"}]}},"response":[],"_postman_id":"7818a40d-3e1f-437e-9c10-00ae8bfb28fe"}],"id":"8af69f91-a02c-4cd8-9b78-bdf67605fb4f","_postman_id":"8af69f91-a02c-4cd8-9b78-bdf67605fb4f","description":""}],"id":"a0fcc94d-a778-4e18-a10c-8e665d912d43","_postman_id":"a0fcc94d-a778-4e18-a10c-8e665d912d43","description":""},{"name":"Webhook","item":[{"name":"User","item":[{"name":"User State Update","id":"9b79e274-c6c3-4382-bc69-b16473e93fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"USER_STATE_UPDATED\",\r\n \"data\": {\r\n \"reason\": \"string\",\r\n \"state\": \"UNACCEPTABLE\"\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9b79e274-c6c3-4382-bc69-b16473e93fa8"},{"name":"IRS Status Update","id":"fd430931-e64c-46e1-b896-59716700e793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"IRS_STATUS_UPDATED\",\r\n \"data\": {\r\n \"reason\": \"string\",\r\n \"status\": \"SUCCESSFUL\"\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"fd430931-e64c-46e1-b896-59716700e793"}],"id":"556fb2ab-e41c-429b-a8ff-eaf12f1abef6","_postman_id":"556fb2ab-e41c-429b-a8ff-eaf12f1abef6","description":""},{"name":"Transaction","item":[{"name":"Transaction State Update","id":"81aa18da-5fb7-4063-9772-e7d462e43307","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"TRANSACTION_STATUS_UPDATED\",\r\n \"data\": {\r\n \"transactionId\": \"string\",\r\n \"reasons\": [\r\n \"string\"\r\n ],\r\n \"status\": \"ALLOW\",\r\n \"comment\": \"string\"\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"81aa18da-5fb7-4063-9772-e7d462e43307"}],"id":"a5d876ef-f2d0-46eb-8aa7-ac5a64969e23","_postman_id":"a5d876ef-f2d0-46eb-8aa7-ac5a64969e23","description":""},{"name":"Case","item":[{"name":"Case Open","id":"91ebe8f1-ac77-4210-ae5b-a09bba84c53d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"TRANSACTION_STATUS_UPDATED\",\r\n \"data\": {\r\n \"transactionId\": \"string\",\r\n \"reasons\": [\r\n \"string\"\r\n ],\r\n \"status\": \"ALLOW\",\r\n \"comment\": \"string\"\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"91ebe8f1-ac77-4210-ae5b-a09bba84c53d"},{"name":"Case Close","id":"3fdb4b8e-ddcf-4e6a-9e6c-1f4c92e43350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"CASE_CLOSED\",\r\n \"data\": {\r\n \"caseId\": \"string\",\r\n \"status\": \"string\",\r\n \"reasons\": [\r\n \"string\"\r\n ],\r\n \"reasonDescriptionForOther\": \"string\",\r\n \"comment\": \"string\",\r\n \"userId\": \"string\",\r\n \"transactionIds\": [\r\n \"string\"\r\n ]\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"3fdb4b8e-ddcf-4e6a-9e6c-1f4c92e43350"}],"id":"74f1477c-ba0d-432a-bb79-30bd3a16b76b","_postman_id":"74f1477c-ba0d-432a-bb79-30bd3a16b76b","description":""},{"name":"Alert","item":[{"name":"Alert Open","id":"2c3b8633-65bc-4024-9b0b-240309852ae0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"ALERT_OPEN\",\r\n \"data\": {\r\n \"alertId\": \"string\",\r\n \"status\": \"string\",\r\n \"transactionIds\": [\r\n \"string\"\r\n ],\r\n \"ruleName\": \"string\",\r\n \"ruleDescription\": \"string\",\r\n \"ruleId\": \"string\",\r\n \"ruleInstanceId\": \"string\",\r\n \"caseId\": \"string\",\r\n \"userId\": \"string\"\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"2c3b8633-65bc-4024-9b0b-240309852ae0"},{"name":"Alert Close","id":"52104413-3ab5-4b82-a0b3-18dd5bbed3c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"ALERT_CLOSED\",\r\n \"data\": {\r\n \"alertId\": \"string\",\r\n \"status\": \"string\",\r\n \"reasons\": [\r\n \"string\"\r\n ],\r\n \"reasonDescriptionForOther\": \"string\",\r\n \"comment\": \"string\",\r\n \"userId\": \"string\",\r\n \"transactionIds\": [\r\n \"string\"\r\n ],\r\n \"ruleName\": \"string\",\r\n \"ruleDescription\": \"string\",\r\n \"ruleId\": \"string\",\r\n \"ruleInstanceId\": \"string\"\r\n },\r\n \"id\": \"string\",\r\n \"triggeredBy\": \"MANUAL\",\r\n \"createdTimestamp\": 1\r\n}","options":{"raw":{"language":"json"}}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"52104413-3ab5-4b82-a0b3-18dd5bbed3c5"}],"id":"8acba1c8-69c8-4d4d-ac37-f2d19df89fe1","_postman_id":"8acba1c8-69c8-4d4d-ac37-f2d19df89fe1","description":""}],"id":"39896707-4326-4b9a-9faa-6448ff94af53","description":"A webhook enables Traxionright to push real-time notifications to your app.
Traxionright uses HTTPS to send these notifications to your app as a JSON
payload. You can then use these notifications to execute actions in your
backend systems.
Webhooks are particularly useful when:
\nA transaction is investigated and approved by your compliance team.
\nA user’s state has changed.
\nA new case or alert is created.
\nA case or alert is closed.
\nA rule action has been updated.
\nYou can start receiving event notifications in your app by following these steps:
\nIdentify the events you want to monitor and the event payloads to parse.
\nCreate a webhook endpoint as an HTTP endpoint (URL) on your server.
\nHandle requests from Traxionright by parsing each event object and returning 2xx response status codes.
\nDeploy your webhook endpoint so that it is publicly accessible via an HTTPS URL.
\nRegister your publicly accessible HTTPS URL in the
Traxionright console and store the secret signing key (for verifying the
payload) in a secure place.
{
\"id\": \"2fa554d3-1ffa-4361-9af6-5479c2d4847f\",
\"type\": \"USER_STATE_UPDATED\",
\"createdTimestamp\": 1661522222301,
\"triggeredBy\": \"MANUAL\",
\"data\": {
\"userId\": \"U-1\",
\"state\": \"BLOCKED\",
\"reason\": \"updated manually\"
}