Welcome to Swipe Issuing. The purpose of this documentation is to ensure that every user is able to properly integrate a full card issuing or fiat banking solution to their system through our series of simple easy-to-use sets of APIs. Here you will find an explanation of how our products work and how to integrate with them.
\nEvery API in our system that provides a list of records has available a set of filters and parameters to make the listings represent the records they are actually looking for. For any GET call for listing records, the following query parameters will be available:
\nwith[]
\nand[]
\nor[]
\nors as needed. An example would be or[tierLevel][][eq]=1.in[]
\nors as needed. An example would be in[tierLevel][]=1&in[tierLevel][]=2&in[tierLevel][]=3.date[]
\ndate[created_at][][gt]=2018-01-01&date[created_at][][lt]=2018-01-31.It is possible to use various type of operators, below is the mapping for each one:
\nThe API accepts as a request a raw JSON body containing the data according to the structure of each object from the API that is being requested. In this documentation, each API has the data structure defined for each API that should be strictly followed.
\nThe response structure of the API follows 2 possible structures based on the success flag which indicates if the request was successful or not.
The success flag indicates the following:
The success flag should not be conflicted with the state or values of the record which was created (like a card order that was created with the status set to failed), the client needs to implement on their side the required logic to properly parse the data created and analyze the relevance of keeping track of the ids of data committed in our database with their system. Below are further examples of our successful/failure responses.
Successful Response
\nAny time the response is successful in a create or update request you will receive the data object containing the record recently created or updated together with any relevant nested relations. In the below example we have a successful card order creation with all result records pointing to that card order.
{\n \"success\": true,\n \"data\": {\n \"id\": 43,\n \"entity_id\": 7,\n \"card_id\": 1,\n \"card_upgrade_id\": null,\n \"asset_id\": null,\n \"exchange_quote_id\": null,\n \"reserve_entry_id\": null,\n \"type\": \"issue\",\n \"amount\": null,\n \"reference\": null,\n \"status\": \"failed\",\n \"created_at\": \"2020-06-28 14:57:17.297761\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-06-28 14:57:17.297761\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1,\n \"results\": [\n {\n \"id\": 37,\n \"card_order_id\": 43,\n \"platform\": \"contis\",\n \"code\": \"internal\",\n \"message\": \"The entity already has an issued consumer id for this platform, only one consumer id is allowed for physical cards on this platform\",\n \"created_at\": \"2020-06-28 14:57:17.344219\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-06-28 14:57:17.344219\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n }\n ]\n }\n}\nFailed Response
\nWhenever the request fails, the response will have an error array containing all relevant messages as to why the request has failed
\n{\n \"success\": false,\n \"error\": [\n {\n \"message\": \"The selected status is invalid.\"\n }\n ]\n}\nGET a list of api keys
\n","urlObject":{"path":["api","v2","apikeys"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"436ad8e6-1ffd-4242-99fe-fbd016063a3b"},{"name":"Query Apikeys By ID","id":"97374b50-581d-4919-84df-3350ec06b5ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/apikeys","description":"GET a specific apikey
\n","urlObject":{"path":["api","v2","apikeys"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"97374b50-581d-4919-84df-3350ec06b5ce"},{"name":"Update Apikey","id":"d505e33b-6513-4db8-bebb-a9bcfc098015","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"login_id\": 2\n}"},"url":"{{url}}/api/v2/apikeys/1","description":"Update an apikey
\n","urlObject":{"path":["api","v2","apikeys","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6d544b18-2e93-48c3-983a-94f123dfeeb9","name":"Update Apikey","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"login_id\": 2\n}"},"url":"{{url}}/api/v2/apikeys/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 May 2020 23:49:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9996"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"59280908edb17411-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"cf-request-id","value":"02ace3f98c00007411bc83d200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"login_id\": 2,\n \"key\": \"da5bf03c29cf00028fc9da2be71b1a18\",\n \"inactive\": 0,\n \"created_at\": \"2020-04-30 22:19:59.000000\",\n \"updated_at\": \"2020-05-12 23:49:17.157160\"\n }\n}"}],"_postman_id":"d505e33b-6513-4db8-bebb-a9bcfc098015"},{"name":"Create Apikeys","id":"eb7e78a3-f3d3-45ae-b88f-08b3c9182c54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"login_id\": 1\n}"},"url":"{{url}}/api/v2/apikeys","description":"Create apikeys
\n","urlObject":{"path":["api","v2","apikeys"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"dde1d7ee-d601-4c43-9066-3798b65e0de4","name":"Create Apikeys","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"login_id\": 1\n}"},"url":"{{url}}/api/v2/apikeys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 May 2020 23:48:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5928082cdeb47411-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"cf-request-id","value":"02ace3700b00007411bcbaa200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"login_id\": 1,\n \"key\": \"8a280e3dc5992972441b95f1aa67f25d\",\n \"updated_at\": \"2020-05-12 23:48:41.955258\",\n \"created_at\": \"2020-05-12 23:48:41.955258\",\n \"id\": 3\n }\n}"}],"_postman_id":"eb7e78a3-f3d3-45ae-b88f-08b3c9182c54"}],"id":"b0d156d1-2c6c-4dc7-8b63-e1196434e243","description":"Every APIKEY is linked to a login, there can be multiple API keys created for the same login. API keys can also be transferred to another login.
Apikey Object
\n","_postman_id":"b0d156d1-2c6c-4dc7-8b63-e1196434e243"},{"name":"2FA Capability for session login","item":[{"name":"Step 1 - Initial login process","id":"0b76a9cf-e4f5-4271-8aff-82fa11fc8530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"username\": \"{{mfaUsername}}\",\n\t\"password\": \"{{mfaPassword}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/login","urlObject":{"path":["api","v2","login"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"030f209e-8b32-4213-99c8-8c50b596b3ce","name":"Aquiring the session token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"username\": \"{{mfaUsername}}\",\n\t\"password\": \"{{mfaPassword}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Jun 2020 13:39:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"039273c5440000d4e0218b9200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5a9755820f5bd4e0-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"sessionToken\": \"eyJpc3MiOiJodHRwOlwvXC9ibmNlMXNydmMuY2FyZGFwaS5uZXRcLyIsImlhdCI6MTU5MzE3ODc2MiwiZXhwIjoxNTkzMTc4NzcyLCJhbGciOiJoczI1NiJ9.eyJpZCI6MywidXNlcm5hbWUiOiJCMkJNYW5hZ2VyIiwiZW1haWwiOiJtYW5hZ2VyQHZlbnVzLmNvbSIsInNlc3Npb24iOnRydWUsIm5vbmNlIjoxNTkzMTc4NzYyODg2NjUwfQ==.NTBlNzE3MDM5ZjI4ODNlNzQyYzVjMTE5N2I5MWY1YWZhOGZhNWZkYjc1ZTJkZTMyMDdiZTAwYzI2YzljYmUxOQ==\",\n \"mfa\": \"software\"\n }\n}"}],"_postman_id":"0b76a9cf-e4f5-4271-8aff-82fa11fc8530"},{"name":"Step 2 - Send the mfa code with session token","id":"f28d79bf-e38e-4de9-85de-3ccc3a6814ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"sessionToken\": \"eyJpc3MiOiJodHRwOlwvXC9ibmNlMXNydmMuY2FyZGFwaS5uZXRcLyIsImlhdCI6MTU5MzE3ODc2MiwiZXhwIjoxNTkzMTc4NzcyLCJhbGciOiJoczI1NiJ9.eyJpZCI6MywidXNlcm5hbWUiOiJCMkJNYW5hZ2VyIiwiZW1haWwiOiJtYW5hZ2VyQHZlbnVzLmNvbSIsInNlc3Npb24iOnRydWUsIm5vbmNlIjoxNTkzMTc4NzYyODg2NjUwfQ==.NTBlNzE3MDM5ZjI4ODNlNzQyYzVjMTE5N2I5MWY1YWZhOGZhNWZkYjc1ZTJkZTMyMDdiZTAwYzI2YzljYmUxOQ==\",\n\t\"code\": \"456987\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/login","urlObject":{"path":["api","v2","login"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"14f716b5-4cb9-444e-8ba1-15669cbfc950","name":"Step 2 - Send the mfa code with session token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"sessionToken\": \"eyJpc3MiOiJodHRwOlwvXC9ibmNlMXNydmMuY2FyZGFwaS5uZXRcLyIsImlhdCI6MTU5MzE3ODc2MiwiZXhwIjoxNTkzMTc4NzcyLCJhbGciOiJoczI1NiJ9.eyJpZCI6MywidXNlcm5hbWUiOiJCMkJNYW5hZ2VyIiwiZW1haWwiOiJtYW5hZ2VyQHZlbnVzLmNvbSIsInNlc3Npb24iOnRydWUsIm5vbmNlIjoxNTkzMTc4NzYyODg2NjUwfQ==.NTBlNzE3MDM5ZjI4ODNlNzQyYzVjMTE5N2I5MWY1YWZhOGZhNWZkYjc1ZTJkZTMyMDdiZTAwYzI2YzljYmUxOQ==\",\n\t\"code\": \"456987\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/login"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": \"eyJpc3MiOiJodHRwOlwvXC9ibmNlMXNydmMuY2FyZGFwaS5uZXRcLyIsImlhdCI6MTU5MzE3ODg4MSwiZXhwIjoxNTkzMTgyNDgxLCJhbGciOiJoczI1NiJ9.eyJpZCI6MywidXNlcm5hbWUiOiJCMkJNYW5hZ2VyIiwiZW1haWwiOiJtYW5hZ2VyQHZlbnVzLmNvbSIsInNlc3Npb24iOmZhbHNlLCJub25jZSI6MTU5MzE3ODg4MTI1OTQzMX0=.NDc4OTA0OWRkYjY1ODFjYTRmMmY3ZGQzNzc4MWFjNzI0YmE3NzZkYzU4YmJlMjRjMGRmNzFiOTQzMzNmM2E1MA==\"\n}"}],"_postman_id":"f28d79bf-e38e-4de9-85de-3ccc3a6814ee"},{"name":"Activating MFA","id":"8cd84789-d54e-454b-a240-cc9c8d58178d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"mfa\": \"software\",\n\t\"mfa_platform\": \"google2fa\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/logins/3","description":"To activate mfa simply send the mfa type you want to activate and the mfa_platform to use. Below is the structure of how accepted values. Everytime this setting is changed you will find the mfa_data field on the response, this field will contain data to be used with the mfa type selected, for example on software it will bring back a data uri image string which will be the QRcode to use with the software so that the code can properly be generated and used with Venus.
Venus has the capability of adding an extra layer of security during session logins so that users can utilize multi-factor authentication. Currently, Venus has software mfa capability. This setting can be adjusting in the login record and once this field is set, whenever the client attempts a login (using the {{url}}/api/v2/login), if the credentials are correct they will receive a session token under sessionToken and an extra field containing the mfa route to use. The flow is as follows:
Step 1
\nsessionToken that needs to be sent back whenever the client has the secondary authentication code ready.P.S. The sessionToken is valid only 10 seconds after it was generated and can only be used on one successful attempt
Step 2
\nsessionToken obtained before with the code generated by the mfa software (google2fa for example) under codeaccessToken to be used normally.On every API call, the header named APIKEY must be sent to authenticate every request.
GET a list of disbursements
\n","urlObject":{"path":["api","v2","disbursements"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46c9d98d-bb7c-40da-bc2f-9c00f744e555"},{"name":"Query Disbursement by ID","id":"d8bf4f2c-0578-4ff6-80a8-9ba01fbef30c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/disbursements/{{disbursementID}}","description":"GET a disbursement by the ID
\n","urlObject":{"path":["api","v2","disbursements","{{disbursementID}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8bf4f2c-0578-4ff6-80a8-9ba01fbef30c"},{"name":"Create Disbursement for Wire","id":"93a7707b-4d5e-4601-9726-cc992dfa42de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\r\n \"entity_id\": 6,\r\n \"asset_id\": 2,\r\n \"amount\": 100,\r\n \"service\": \"wire\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/disbursements","description":"Create a disbursement, if the option wire was chosen as service than the banking_instructions will come in the response
When creating a disbursement for an ACH service, the client needs to make sure that the account was properly creating using the Plaid flow (check Accounts APIs), therefore containing the approved account_id to use with the disbursement.
Update a disbursement
\n","urlObject":{"path":["api","v2","disbursements","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3db1df58-0146-4d08-87d0-44b1ce2b833d","name":"Update Disbursement","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"processed\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/disbursements/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Aug 2020 03:04:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"04ab6ca348000004610a10f200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5c58e3b20b290461-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"entity_id\": 6,\n \"asset_id\": 2,\n \"account_id\": null,\n \"service\": \"wire\",\n \"reference\": null,\n \"platform\": null,\n \"status\": \"processed\",\n \"amount\": \"100.000000000\",\n \"clear_at\": null,\n \"cleared_at\": \"2020-08-20 03:04:53\",\n \"message\": null,\n \"created_at\": \"2020-08-20 03:03:05.175433\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-08-20 03:04:53.510202\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1,\n \"bank_instructions\": {\n \"bankName\": \"Wellsfargo Bank N.A.\",\n \"bankAddress\": \"123 Wellsfargo St.\",\n \"bankCity\": \"Tulsa\",\n \"bankState\": \"OK\",\n \"bankCountry\": \"US\",\n \"bankPhone\": \"18889996666\",\n \"routing\": \"123456789\",\n \"accountNumber\": \"123456789\",\n \"accountType\": \"checking\",\n \"swift\": \"WSF23GO\",\n \"reference\": 1\n },\n \"asset\": {\n \"id\": 2,\n \"login_id\": 2,\n \"partition_id\": 1,\n \"from_asset_id\": null,\n \"fund_id\": 1,\n \"name\": \"EUR\",\n \"symbol\": \"EUR\",\n \"color\": \"#000000\",\n \"base\": 0,\n \"receive\": 1,\n \"send\": 1,\n \"order\": 2,\n \"type\": \"currency\",\n \"platform\": \"default\",\n \"reference\": null,\n \"bank_instructions\": {\n \"bankName\": \"Wellsfargo Bank N.A.\",\n \"bankAddress\": \"123 Wellsfargo St.\",\n \"bankCity\": \"Tulsa\",\n \"bankState\": \"OK\",\n \"bankCountry\": \"US\",\n \"bankPhone\": \"18889996666\",\n \"routing\": \"123456789\",\n \"accountNumber\": \"123456789\",\n \"accountType\": \"checking\",\n \"swift\": \"WSF23GO\"\n },\n \"favorite\": 0,\n \"inactive\": 0,\n \"created_at\": \"2020-06-24 22:54:05.029397\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-06-24 22:55:49.675304\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n },\n \"entity\": {\n \"id\": 6,\n \"login_id\": 2,\n \"fund_id\": null,\n \"currency_asset_id\": null,\n \"referral_code_id\": null,\n \"reference\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"address1\": \"123 Elm St.\",\n \"address2\": null,\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"country\": \"US\",\n \"nin\": \"1239754456789\",\n \"nin_type\": \"nationalId\",\n \"nin_issue_date\": null,\n \"nin_exp_date\": null,\n \"email\": \"john.doe.sanders@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19541184203\",\n \"tier_level\": 2,\n \"tier_status\": \"completed\",\n \"bank_acceptance\": 0,\n \"favorite_funds\": 0,\n \"favorite_assets\": 0,\n \"discount\": 0,\n \"inactive\": 0,\n \"freeze\": 0,\n \"created_at\": \"2020-06-24 14:12:32.535852\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-06-24 14:12:32.535852\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n }\n }\n}"},{"id":"9f957f94-f251-48d9-a07b-3b6335b4c5d2","name":"Create Disbursement","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\r\n \"entity_id\": 6,\r\n \"asset_id\": 2,\r\n \"amount\": 100,\r\n \"service\": \"wire\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/disbursements"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 20 Aug 2020 03:03:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9994"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"04ab6afd94000004610a342200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5c58e10f5c000461-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"entity_id\": 6,\n \"asset_id\": 2,\n \"account_id\": null,\n \"service\": \"wire\",\n \"reference\": null,\n \"platform\": null,\n \"status\": \"processing\",\n \"amount\": \"100.000000000\",\n \"clear_at\": null,\n \"cleared_at\": null,\n \"message\": null,\n \"created_at\": \"2020-08-20 03:03:05.175433\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-08-20 03:03:05.175433\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1,\n \"bank_instructions\": {\n \"bankName\": \"Wellsfargo Bank N.A.\",\n \"bankAddress\": \"123 Wellsfargo St.\",\n \"bankCity\": \"Tulsa\",\n \"bankState\": \"OK\",\n \"bankCountry\": \"US\",\n \"bankPhone\": \"18889996666\",\n \"routing\": \"123456789\",\n \"accountNumber\": \"123456789\",\n \"accountType\": \"checking\",\n \"swift\": \"WSF23GO\",\n \"reference\": 1\n },\n \"asset\": {\n \"id\": 2,\n \"login_id\": 2,\n \"partition_id\": 1,\n \"from_asset_id\": null,\n \"fund_id\": 1,\n \"name\": \"EUR\",\n \"symbol\": \"EUR\",\n \"color\": \"#000000\",\n \"base\": 0,\n \"receive\": 1,\n \"send\": 1,\n \"order\": 2,\n \"type\": \"currency\",\n \"platform\": \"default\",\n \"reference\": null,\n \"bank_instructions\": {\n \"bankName\": \"Wellsfargo Bank N.A.\",\n \"bankAddress\": \"123 Wellsfargo St.\",\n \"bankCity\": \"Tulsa\",\n \"bankState\": \"OK\",\n \"bankCountry\": \"US\",\n \"bankPhone\": \"18889996666\",\n \"routing\": \"123456789\",\n \"accountNumber\": \"123456789\",\n \"accountType\": \"checking\",\n \"swift\": \"WSF23GO\"\n },\n \"favorite\": 0,\n \"inactive\": 0,\n \"created_at\": \"2020-06-24 22:54:05.029397\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-06-24 22:55:49.675304\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n },\n \"entity\": {\n \"id\": 6,\n \"login_id\": 2,\n \"fund_id\": null,\n \"currency_asset_id\": null,\n \"referral_code_id\": null,\n \"reference\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"address1\": \"123 Elm St.\",\n \"address2\": null,\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"country\": \"US\",\n \"nin\": \"1239754456789\",\n \"nin_type\": \"nationalId\",\n \"nin_issue_date\": null,\n \"nin_exp_date\": null,\n \"email\": \"john.doe.sanders@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19541184203\",\n \"tier_level\": 2,\n \"tier_status\": \"completed\",\n \"bank_acceptance\": 0,\n \"favorite_funds\": 0,\n \"favorite_assets\": 0,\n \"discount\": 0,\n \"inactive\": 0,\n \"freeze\": 0,\n \"created_at\": \"2020-06-24 14:12:32.535852\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-06-24 14:12:32.535852\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n }\n }\n}"}],"_postman_id":"a11b04de-39ee-44af-8cfb-9859541b4cef"}],"id":"d6e4da6a-09d3-444c-8ef7-8bc4471c73f4","description":"The disbursement resource represents a withdrawal or deposit of currency at a specific banking location. Each disbursement is linked to a service, which defines how the method in which the financial operation will reach the entity's account. The disbursement is considered to be an origin of funds in our system, and therefore, possible to be used during the backing of any financial operation within the system, like an internal transfer between two entities for example. Disbursements have certain statuses which represent how the entity is impacted internally on their funds as well, below you can see a clear breakdown:
\nTo issue withdrawal disbursements (amount less than 0) the entity must have funds available in the system.
\nDisbursement Object
\n","_postman_id":"d6e4da6a-09d3-444c-8ef7-8bc4471c73f4"},{"name":"Accounts","item":[{"name":"Query Account List","event":[{"listen":"prerequest","script":{"id":"1986d4ff-b721-4241-81eb-840b7cd5dd4b","exec":[""],"type":"text/javascript"}}],"id":"f090925d-683d-4750-a495-d000ba69785d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/accounts","description":"GET a list of accounts
\n","urlObject":{"path":["api","v2","accounts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3d946cb7-37e1-43b6-aacd-636ef055fbde","name":"Query By Filter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":{"raw":"{{url}}/api/v2/entities?limit=2","host":["{{url}}"],"path":["api","v2","entities"],"query":[{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 22:37:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588b111b9f22feee-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024ac9053d0000feeea0093200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"nin_type\": \"nationalId\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n },\n {\n \"id\": 1,\n \"firstName\": \"Melissa\",\n \"lastName\": \"Jones\",\n \"country\": \"US\",\n \"address\": \"123 Oak St.\",\n \"city\": \"San Bernadino\",\n \"state\": \"CA\",\n \"zipcode\": \"33180\",\n \"nin\": \"987654321\",\n \"nin_type\": \"driverLicense\",\n \"nin_issue_date\": \"2000-01-01\",\n \"nin_exp_date\": \"2025-01-01\",\n \"email\": \"melissa.jones@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n }\n ],\n \"links\": {\n \"first\": \"https://usnvspd1.spendsdk.com/api/v2/entities?page=1\",\n \"last\": \"https://usnvspd1.spendsdk.com/api/v2/entities?page=24334\",\n \"prev\": null,\n \"next\": \"https://usnvspd1.spendsdk.com/api/v2/entities?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 24334,\n \"path\": \"https://usnvspd1.spendsdk.com/api/v2/entities\",\n \"per_page\": \"2\",\n \"to\": 2,\n \"total\": 48667\n }\n}"}],"_postman_id":"f090925d-683d-4750-a495-d000ba69785d"},{"name":"Query Account by ID","event":[{"listen":"prerequest","script":{"id":"00c3e431-2666-410c-8edb-1cea07ddd166","exec":[""],"type":"text/javascript"}}],"id":"1225ff46-dfd0-424e-8665-0dc2bc7ae058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/api/v2/accounts/{{accountID}}","description":"GET information of an account
\n","urlObject":{"path":["api","v2","accounts","{{accountID}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3b01a481-14b6-478e-81d6-e4817bfedcfb","name":"Query By Filter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{url}}/api/v2/entities?limit=2","host":["{{url}}"],"path":["api","v2","entities"],"query":[{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 22:37:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588b111b9f22feee-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024ac9053d0000feeea0093200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n }\n}"}],"_postman_id":"1225ff46-dfd0-424e-8665-0dc2bc7ae058"},{"name":"Create Account With Plaid","event":[{"listen":"prerequest","script":{"id":"dd9d4ddf-28f2-478f-910e-0421a6027626","exec":[""],"type":"text/javascript"}}],"id":"cb75bd24-7389-48ca-9356-8f8cb55a31ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entity_id\": 828,\r\n \"public_token\": \"public-sandbox-0773f445-f214-4d02-bb79-baa3a7f8189d\",\r\n \"account_token\": \"po7VVEQlLjHRe85ExVzBf7eLzdv9k5uLMGlJp\"\r\n}"},"url":"{{url}}/api/v2/accounts","description":"When creating an account with Plaid, the API expects to main parameters in the payload, the public_token and the account_token. The public_token is acquired in the Plaid SDK/Frame callback after the user has fully authenticated their bank account, the account_token (referenced as the account_id in Plaid) is also acquired in this stage, it represents the account within the bank that the user would like to use (savings, checking, etc.).
Account Create Request with Plaid
\n","urlObject":{"path":["api","v2","accounts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"13cfa5b9-90d6-42cf-abc3-156778104efb","name":"Create Account With Plaid","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entity_id\": 828,\r\n \"public_token\": \"public-sandbox-0773f445-f214-4d02-bb79-baa3a7f8189d\",\r\n \"account_token\": \"po7VVEQlLjHRe85ExVzBf7eLzdv9k5uLMGlJp\"\r\n}"},"url":"{{url}}/api/v2/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Oct 2020 22:29:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9999"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"061813aee9000037115a3b7000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5ea0555e4c693711-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 3,\n \"entity_id\": 828,\n \"account_format_id\": 1,\n \"status\": \"verified\",\n \"created_at\": \"2020-10-29 22:29:07.891902\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.071350\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1,\n \"fields\": [\n {\n \"id\": 6,\n \"account_id\": 3,\n \"field\": \"routingNumber\",\n \"value\": \"011401533\",\n \"created_at\": \"2020-10-29 22:29:09.272870\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.272870\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n },\n {\n \"id\": 7,\n \"account_id\": 3,\n \"field\": \"accountNumber\",\n \"value\": \"1111222233330000\",\n \"created_at\": \"2020-10-29 22:29:09.299682\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.299682\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n },\n {\n \"id\": 8,\n \"account_id\": 3,\n \"field\": \"name\",\n \"value\": \"Plaid Checking\",\n \"created_at\": \"2020-10-29 22:29:09.324768\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.324768\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n },\n {\n \"id\": 9,\n \"account_id\": 3,\n \"field\": \"balance\",\n \"value\": \"100\",\n \"created_at\": \"2020-10-29 22:29:09.347536\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.347536\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n },\n {\n \"id\": 10,\n \"account_id\": 3,\n \"field\": \"account_id\",\n \"value\": \"po7VVEQlLjHRe85ExVzBf7eLzdv9k5uLMGlJp\",\n \"created_at\": \"2020-10-29 22:29:09.369712\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.369712\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n }\n ]\n }\n}"},{"id":"3c05a3e7-2c82-422f-82c9-c1b2f27f8691","name":"Create Account With Plaid Pending","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"entity_id\": 828,\r\n \"public_token\": \"public-sandbox-0773f445-f214-4d02-bb79-baa3a7f8189d\",\r\n \"account_token\": \"po7VVEQlLjHRe85ExVzBf7eLzdv9k5uLMGlJp\"\r\n}"},"url":"{{url}}/api/v2/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 29 Oct 2020 22:29:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9999"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"061813aee9000037115a3b7000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5ea0555e4c693711-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"entity_id\": 828,\n \"account_format_id\": 1,\n \"status\": \"pending\",\n \"created_at\": \"2020-10-29 22:29:07.891902\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-10-29 22:29:09.071350\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n }\n}"}],"_postman_id":"cb75bd24-7389-48ca-9356-8f8cb55a31ee"}],"id":"031209b8-fbfd-403b-ba26-dcc046d0766b","description":"The accounts resources enable the user to add their bank account so that it can be used for disbursements. The B2B API offers a simple one request solution that will ultimately add the user's bank information and also run necessary risk checks to guarantee account ownership. Currently, the only supported format for US users to bring accounts to the system is through Plaid. The account record is composed of statuses that indicate if the account is ready for usage or if the entity on file is truly enabled to use the account.
\nAccount Object
\nAccount Field Object
\n","_postman_id":"031209b8-fbfd-403b-ba26-dcc046d0766b"}],"id":"0d7aa5dd-db7b-4b48-aba8-a7dbbc8d8b93","event":[{"listen":"prerequest","script":{"id":"e70687db-7e0b-43b5-bb21-347487b4ce4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab7c0f0b-fbfe-4001-9137-5819058f0d83","type":"text/javascript","exec":[""]}}],"_postman_id":"0d7aa5dd-db7b-4b48-aba8-a7dbbc8d8b93","description":""},{"name":"Cards","item":[{"name":"Card Orders","item":[{"name":"Query Card Orders List","event":[{"listen":"prerequest","script":{"id":"ded5b901-f10b-47e2-b688-33e0cfdc5fcd","exec":[""],"type":"text/javascript"}}],"id":"deb1fac0-c56d-4974-98ad-7b7faf18fcdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Joohnnyha\",\n \"lastName\": \"Doweri\",\n \"country\": \"US\",\n \"address\": \"123 Efplm St.\",\n \"city\": \"Somewdhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"1234128533256789\",\n \"nin_type\": \"nationalId\",\n \"email\": \"john.doe10823123123@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544886123213\",\n \"inactive\": 0\n}"},"url":"{{url}}/api/v2/cardOrders","description":"GET a list of card orders
\n","urlObject":{"path":["api","v2","cardOrders"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"35ddbab0-0f32-4352-9f12-7fd245b57597","name":"Query Card Orders","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":{"raw":"{{url}}/api/v2/cardOrders?and[status][][eq]=verified&limit=2","host":["{{url}}"],"path":["api","v2","cardOrders"],"query":[{"key":"and[status][][eq]","value":"verified","description":"Optional parameter to filter by status"},{"key":"limit","value":"2","description":"Optional parameter to limit in 2 results"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 03:41:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588492505c1eb935-MIA"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"0246b9c6320000b935a0023200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 5,\n \"entity_id\": 314,\n \"card_id\": 3,\n \"card_upgrade_id\": null,\n \"reference\": null,\n \"type\": \"issue\",\n \"status\": \"verified\",\n \"created_at\": \"2018-12-25 14:06:51\",\n \"updated_at\": \"2019-12-12 06:04:15\"\n },\n {\n \"id\": 8,\n \"entity_id\": 4013,\n \"card_id\": 2,\n \"card_upgrade_id\": null,\n \"amount\": null,\n \"reference\": null,\n \"type\": \"issue\",\n \"status\": \"verified\",\n \"created_at\": \"2019-01-23 01:47:31\",\n \"updated_at\": \"2019-01-23 01:53:37\"\n }\n ],\n \"links\": {\n \"first\": \"https://usnvspd1.cardapi.com/api/v2/cardOrders?page=1\",\n \"last\": \"https://usnvspd1.cardapi.com/api/v2/cardOrders?page=972\",\n \"prev\": null,\n \"next\": \"https://usnvspd1.cardapi.com/api/v2/cardOrders?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 972,\n \"path\": \"https://usnvspd1.cardapi.com/api/v2/cardOrders\",\n \"per_page\": \"2\",\n \"to\": 2,\n \"total\": 1944\n }\n}"}],"_postman_id":"deb1fac0-c56d-4974-98ad-7b7faf18fcdb"},{"name":"Query Card Order By ID","event":[{"listen":"prerequest","script":{"id":"96852e45-cbc2-4f84-8bab-65bc61a77317","exec":[""],"type":"text/javascript"}}],"id":"4d3e386d-df64-4a32-8561-c14a66be53d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/cardOrders/264","description":"GET the information of a specific card order
\n","urlObject":{"path":["api","v2","cardOrders","264"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"86d1baa0-de6d-405a-9e97-72ce2e0a95a4","name":"Query Card Order By ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/cardOrders/264"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 03:44:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9996"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588496a84ea2b935-MIA"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"0246bc7d2f0000b935a01f0200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 264,\n \"entity_id\": 24957,\n \"card_id\": 1,\n \"card_upgrade_id\": null,\n \"reference\": null,\n \"type\": \"issue\",\n \"status\": \"verified\",\n \"created_at\": \"2019-04-23 00:42:08\",\n \"updated_at\": \"2019-04-23 00:42:09\",\n \"entity_card\": {\n \"id\": 263,\n \"card_order_id\": 264,\n \"entity_id\": 24957,\n \"card_id\": 1,\n \"from_entity_card_id\": null,\n \"reference\": \"ec8c0c64-a3c4-4524-9015-a610c96ec592\",\n \"number\": \"**** **** **** 1399\",\n \"cvv\": \"***\",\n \"expiry_date\": \"0423\",\n \"balance\": \"0.000000000\",\n \"daily_purchase_total\": \"0.000000000\",\n \"daily_atm_total\": \"0.000000000\",\n \"monthly_purchase_total\": \"0.000000000\",\n \"monthly_atm_total\": \"0.000000000\",\n \"physical\": true,\n \"virtual\": false,\n \"gift\": false,\n \"locked\": false,\n \"activated\": true,\n \"pin_set\": true,\n \"status\": \"processed\",\n \"freeze\": 0,\n \"created_at\": \"2019-04-23 00:42:08\",\n \"updated_at\": \"2020-04-23 00:00:52\",\n \"deleted_at\": null\n }\n }\n}"}],"_postman_id":"4d3e386d-df64-4a32-8561-c14a66be53d1"},{"name":"Update Card Order","event":[{"listen":"prerequest","script":{"id":"ab6b8051-719b-4328-b4b2-ec0203ac9a5c","exec":[""],"type":"text/javascript"}}],"id":"3757f6af-e8e9-4627-b9b4-eeb4bdf38098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n \"status\": \"verified\"\n}"},"url":"{{url}}/api/v2/cardOrders/194","description":"The only field that can be updated in a card order is the status. Once a card order is in failed status it can not be reversed. When the card order is in processing status, it can only be updated to failed or verified status. The card is only issued when the card order is set to verified.
To create a card order it is necessary to make sure that the entity is in tier 2 completed status or the request will return an error. There are certain scenarios that influence directly how the card order is processed according to the type and status. The examples are:
Types
\nissue under verified status, the system will try to instantly issue an entity card. In case it succeeds, the entity card will come in the request.issue under processing status, it will put the card order in a queue for further processing through a batch run.issue under reissue status, the system will attempt to instantly reissue the entity card against the card program id provided. It is required that the entity has an active card so that a reissue is possible.upgrade under verified status, the system will try to instantly issue an entity card. In case it succeeds, the entity card will come in the request. The previous card will be deactivated once the newly issued card is activated.The card order is the initial stage of a card issuance process. Each card order is issued against an entity that is tier 2 completed, which means that they have passed KYC clearance (check Risk section for details). During the card order process, it is important to understand the type of card order to create and the card_id to issue it against. A card_id is a unique static number assigned to your account and provided by your manager which represents the card program itself (such as limits, card material, etc.).
Card Order Object
\n","event":[{"listen":"prerequest","script":{"id":"f473848b-543c-4126-a492-8b8aa3d28372","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"84ce76b5-ce5a-4038-be45-bd2a8fd1681d","type":"text/javascript","exec":[""]}}],"_postman_id":"0c5caaa8-dc63-4b65-81a4-5034fbd5c192"},{"name":"Card Transactions","item":[{"name":"Query Card Transaction List","event":[{"listen":"prerequest","script":{"id":"0e0f9efd-67be-49fa-ab9c-0683fafe2b7e","exec":[""],"type":"text/javascript"}}],"id":"5742cd27-7383-4304-97f9-a6b62995478c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/cardTransactions?limit=1&order[id]=desc","description":"GET list of card transactions
\n","urlObject":{"path":["api","v2","cardTransactions"],"host":["{{url}}"],"query":[{"key":"limit","value":"1"},{"key":"order[id]","value":"desc"}],"variable":[]}},"response":[{"id":"b0beffb2-42c1-4757-9020-8d6a0d6abf45","name":"Query Card Transaction List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{url}}/api/v2/cardTransactions?limit=1&order[id]=desc","host":["{{url}}"],"path":["api","v2","cardTransactions"],"query":[{"key":"limit","value":"1"},{"key":"order[id]","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Jun 2020 03:50:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"0338cc9a590000e97c363cd200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5a07e3a3ce0ae97c-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 91255,\n \"from_card_transaction_id\": null,\n \"entity_card_id\": 3350,\n \"transaction_id\": 320527,\n \"merchant\": \"SwipeMerchantMerchant1\",\n \"merchant_address\": null,\n \"merchant_city\": null,\n \"merchant_state\": null,\n \"merchant_country\": null,\n \"reference\": \"400807\",\n \"authorization\": \"972615\",\n \"mcc\": null,\n \"type\": \"auth\",\n \"status\": \"pending\",\n \"currency\": \"EUR\",\n \"local_currency\": null,\n \"local_amount\": null,\n \"exchange_rate\": null,\n \"channel\": null,\n \"pin_present\": 0,\n \"card_present\": 0,\n \"approved\": \"18.000000000\",\n \"total\": \"18.000000000\",\n \"created_at\": \"2020-06-04 23:03:21.589803\",\n \"updated_at\": \"2020-06-04 23:03:23.228959\"\n }\n ],\n \"links\": {\n \"first\": \"http://bta1stg.cardapi.net/api/v2/cardTransactions?page=1\",\n \"last\": \"http://bta1stg.cardapi.net/api/v2/cardTransactions?page=76\",\n \"prev\": null,\n \"next\": \"http://bta1stg.cardapi.net/api/v2/cardTransactions?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 76,\n \"path\": \"http://bta1stg.cardapi.net/api/v2/cardTransactions\",\n \"per_page\": \"1\",\n \"to\": 1,\n \"total\": 76\n }\n}"}],"_postman_id":"5742cd27-7383-4304-97f9-a6b62995478c"}],"id":"557120b0-a2dd-402d-bcbb-399f1b7b2488","description":"Card transactions represent all transactions an entity did on their card. It is very useful information that can be used to reconcile with your systems ledger and help you properly track the funding process with your system. Currently, there are five transaction types, all with its unique use case. Below are explanation of each card transaction type and what it means
\nAUTH type\nThis transaction is a pre-authorization. When a merchant obtains approval for this type of transaction, funds are kept on hold by the bank until the merchant officially captures, because of interchange costs and risks some merchants rather wait till the end of the day (or more when being a hotel for example) to capture all the transaction at a later time. Until that happens funds are kept on hold by the bank, neither the issuer (you) pays or the merchant receives the funds until they officially capture it. This transaction is considered final when the total approved amount is fully captured by the merchant.
\nSALE type\nThe sale transaction types are the most simple ones throughout all the other types, and the reason is due to the fact that the transactions come already captured (settled). This means that as soon as you approve it, funds are immediately settled and no more action is required. For this matter, you will always see sale type card transaction only be on pending status in case it's pending on a confirmation from the POS/ATM reporting the operation was properly finalized.
\nREFUND type\nRefunds are credits that merchants issue against the user's card. The main difference a refund has from an unauth is the fact that it is not linked to any previous pending pre-authorization.
CAPTURE type\nA capture type is a transaction that will indicate a previous pre-authorization was settled. The captured amount can be greater, lower, or equal to the initial pre-authorization amount. In the event of a tip or any extra charge, it is on the capture that this amount will be present.
\nUNATH type\nAn unauth type is the opposite of a capture. It will indicate a previous pre-authorization was reversed either partially or fully. The reversed amount can only be equal to or lower than the initial pre-authorization amount.
\nIt is important to point out that only the approved amount from auth types can change, for all other types they are final and can not be changed.
Card Transaction Object
\n","_postman_id":"557120b0-a2dd-402d-bcbb-399f1b7b2488"},{"name":"Entity Cards","item":[{"name":"Query Entity Cards List","event":[{"listen":"prerequest","script":{"id":"941cf0d7-3c76-4146-935d-c7005a632a17","exec":[""],"type":"text/javascript"}}],"id":"ce388b1c-7c05-475a-b778-0a734507245a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entityCards","description":"GET a list of entity cards
\n","urlObject":{"path":["api","v2","entityCards"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fc501070-ae05-45d9-a19c-a386bb72407a","name":"Query By Filter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":{"raw":"{{url}}/api/v2/entityCards?limit=3","host":["{{url}}"],"path":["api","v2","entityCards"],"query":[{"key":"limit","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 13:12:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9996"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5887d6667b88b91d-MIA"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"0248c4540e0000b91dd999a200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 4,\n \"card_order_id\": null,\n \"entity_id\": 2,\n \"card_id\": 1,\n \"from_entity_card_id\": null,\n \"reference\": \"274198852\",\n \"number\": \"**** **** **** 9035\",\n \"cvv\": \"***\",\n \"expiry_date\": \"0918\",\n \"balance\": \"0.000000000\",\n \"daily_purchase_total\": \"0.000000000\",\n \"daily_atm_total\": \"0.000000000\",\n \"monthly_purchase_total\": \"0.000000000\",\n \"monthly_atm_total\": \"0.000000000\",\n \"physical\": false,\n \"virtual\": true,\n \"gift\": false,\n \"locked\": false,\n \"activated\": false,\n \"pin_set\": false,\n \"status\": \"shipped\",\n \"freeze\": 0,\n \"created_at\": \"2018-09-13 04:55:16\",\n \"updated_at\": \"2019-04-24 02:59:56\",\n \"deleted_at\": null\n },\n {\n \"id\": 5,\n \"card_order_id\": null,\n \"entity_id\": 2,\n \"card_id\": 1,\n \"from_entity_card_id\": null,\n \"reference\": \"288886982\",\n \"number\": \"**** **** **** 4628\",\n \"cvv\": \"***\",\n \"expiry_date\": \"0918\",\n \"balance\": \"0.000000000\",\n \"daily_purchase_total\": \"0.000000000\",\n \"daily_atm_total\": \"0.000000000\",\n \"monthly_purchase_total\": \"0.000000000\",\n \"monthly_atm_total\": \"0.000000000\",\n \"physical\": false,\n \"virtual\": true,\n \"gift\": false,\n \"locked\": false,\n \"activated\": false,\n \"pin_set\": false,\n \"status\": \"1\",\n \"freeze\": 0,\n \"created_at\": \"2018-09-14 03:30:49\",\n \"updated_at\": \"2018-10-07 23:33:29\",\n \"deleted_at\": null\n },\n {\n \"id\": 6,\n \"card_order_id\": null,\n \"entity_id\": 2,\n \"card_id\": 3,\n \"from_entity_card_id\": null,\n \"reference\": \"767182896\",\n \"number\": \"**** **** **** 2274\",\n \"cvv\": \"***\",\n \"expiry_date\": \"0918\",\n \"balance\": \"0.000000000\",\n \"daily_purchase_total\": \"0.000000000\",\n \"daily_atm_total\": \"0.000000000\",\n \"monthly_purchase_total\": \"0.000000000\",\n \"monthly_atm_total\": \"0.000000000\",\n \"physical\": true,\n \"virtual\": false,\n \"gift\": false,\n \"locked\": false,\n \"activated\": false,\n \"pin_set\": false,\n \"status\": \"1\",\n \"freeze\": 0,\n \"created_at\": \"2018-09-14 03:40:22\",\n \"updated_at\": \"2018-09-29 02:54:12\",\n \"deleted_at\": null\n }\n ],\n \"links\": {\n \"first\": \"https://usnvspd1.spendsdk.com/api/v2/entityCards?page=1\",\n \"last\": \"https://usnvspd1.spendsdk.com/api/v2/entityCards?page=968\",\n \"prev\": null,\n \"next\": \"https://usnvspd1.spendsdk.com/api/v2/entityCards?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 968,\n \"path\": \"https://usnvspd1.spendsdk.com/api/v2/entityCards\",\n \"per_page\": \"3\",\n \"to\": 3,\n \"total\": 2903\n }\n}"}],"_postman_id":"ce388b1c-7c05-475a-b778-0a734507245a"},{"name":"Query Entity Card By ID","event":[{"listen":"prerequest","script":{"id":"efb0539c-09d6-4c72-8a25-f43cc6cb28ad","exec":[""],"type":"text/javascript"}}],"id":"9e166a59-f7dc-428f-bf0b-7878146e6e11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entityCards/1","description":"GET the information of a specific entity card
\n","urlObject":{"path":["api","v2","entityCards","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e166a59-f7dc-428f-bf0b-7878146e6e11"},{"name":"Update Entity Card","event":[{"listen":"prerequest","script":{"id":"422befd9-4026-4e86-9cd1-ff4eb5febf75","exec":[""],"type":"text/javascript"}}],"id":"92c19690-0651-4803-b7e2-b5f9bce4eabb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"activated\": 1,\n\t\"cvv\": \"123\"\n}"},"url":"{{url}}/api/v2/entityCards/{{entityCardId}}","description":"Updating certain card fields will be required so that the card functions properly. Below are the use cases and fields that can be updated for the user's card.
\nActivation
\nThe activation process is very simple, it is required to send the activated field set to 1 and the cvv information on the request body. Both are mandatory for activation, once successful the card will be ready for usage.
Lock/Unlock Feature
\nThe lock and unlock feature is also very simple, essentially the card is unlocked by default, which means the locked flag is set to 0. To lock a card, simply update the locked field to 1. After locking the card, any authorization that is received will automatically be declined until it is unlocked again.
Freeze Feature
\nThe freeze feature was introduced to provide the issuer a way to freeze operations on the card in a way that it overrides the lock/unlock feature explained before. It is a flag only the issuer should set in case of actual need.
\nCard Replacement
\nThe card replacement can be done by updating the card status to replacement this process will issue a brand new card to the end-user and once activated, will terminate all previous ones. Replacements can only be done when the card status is processing, processed or shipped and it must be a physical card.
Set Pin
\nThe pin setting feature is available when the card program has the pin_type setting set to settable. Entity cards under these programs can set the pin by sending the pin field in the body during a PUT request and if all went well a successful message will come in the response (the pin is not saved and won't come in the response for settable pin type programs). Only activated cards can set/change the pin. The pin setting is directly related to how the pin_set flag on the entity card record, this field will indicate if the pin was ever set through the our system (so the client can advise the user to change their pin from the default one for example), once the pin is set for the first time this flag is set to 1 and never changed again.
Every card issued in the system is an entity card. It represents the actual card issued with the network and also contains important information for tracking limits, when that card is active, lock and unlock features, the status of the card (including shipping status), and other important characteristics. It is the primary record that will be used for as long as the user is part of the card program. It is important to keep in mind that although a user can be issued multiple cards, only one active card is allowed. Therefore, previous records will still be available for querying purposes but only one active card is permitted per user.
\nEntity Card Object
\n","event":[{"listen":"prerequest","script":{"id":"5554d16e-eaec-41bd-88fb-15b0f5788584","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eb4144be-df44-4490-bc2d-4f9056bb6772","type":"text/javascript","exec":[""]}}],"_postman_id":"d14dbde4-6f37-416e-b7b6-ed936b19c5c0"},{"name":"Authentications","item":[{"name":"Query Entity Card Authentication List","id":"3ac6ded5-68bb-49e1-9fb9-7c2ab99da6a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entityCardAuthentications","description":"GET a list of entity card authentications
\n","urlObject":{"path":["api","v2","entityCardAuthentications"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ff285c8d-9520-4777-abab-359b36b24b29","name":"Query Entity Card Authentication List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entityCardAuthentications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 15 Jul 2021 20:48:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"791"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9994"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"entity_card_id\": 37461,\n \"type\": \"3ds\",\n \"first_factor\": null,\n \"second_factor\": null,\n \"merchant\": \"Carrefour\",\n \"total\": \"50.000000000\",\n \"currency\": \"EUR\",\n \"reference\": \"2453245234236\",\n \"status\": \"pending\",\n \"expire_at\": \"2021-07-15 20:50:00.000000\",\n \"created_at\": \"2021-07-15 20:43:03.456231\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2021-07-15 20:43:03.456231\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n }\n ],\n \"links\": {\n \"first\": \"https://btga2.cardstagingapi.net/api/v2/entityCardAuthentications?page=1\",\n \"last\": \"https://btga2.cardstagingapi.net/api/v2/entityCardAuthentications?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://btga2.cardstagingapi.net/api/v2/entityCardAuthentications\",\n \"per_page\": 50,\n \"to\": 1,\n \"total\": 1\n }\n}"}],"_postman_id":"3ac6ded5-68bb-49e1-9fb9-7c2ab99da6a7"},{"name":"Query Entity Card Authentication By ID","id":"7c3a2347-2893-46a5-926e-2af854f8896f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/api/v2/entityCardAuthentications/{{entityCardAuthenticationID}}","description":"GET a list of entity card authentications
\n","urlObject":{"path":["api","v2","entityCardAuthentications","{{entityCardAuthenticationID}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"bdfd9b70-9ab9-4667-b354-8835cc0eaeae","name":"Query Entity Card Authentication By ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/api/v2/entityCardAuthentications/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 15 Jul 2021 20:48:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"420"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9996"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"entity_card_id\": 37461,\n \"type\": \"3ds\",\n \"first_factor\": null,\n \"second_factor\": null,\n \"merchant\": \"Carrefour\",\n \"total\": \"50.000000000\",\n \"currency\": \"EUR\",\n \"reference\": \"2453245234236\",\n \"status\": \"pending\",\n \"expire_at\": \"2021-07-15 20:50:00.000000\",\n \"created_at\": \"2021-07-15 20:43:03.456231\",\n \"created_by_id\": 6,\n \"created_from_id\": 1,\n \"updated_at\": \"2021-07-15 20:43:03.456231\",\n \"updated_by_id\": 6,\n \"updated_from_id\": 1\n }\n}"}],"_postman_id":"7c3a2347-2893-46a5-926e-2af854f8896f"},{"name":"Update Entity Card Authentication","id":"c56c13ea-df16-47b0-a8a1-f2e1b0fa656b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"approved\",\n \"first_factor\": \"face\",\n \"second_factor\": \"password\"\n}"},"url":"{{url}}/api/v2/entityCardAuthentications/{{entityCardAuthenticationID}}","description":"The update process of an authentication record has certain rules according to the type. In general, only authentications in pending status can be updated, this serves for all types. The rules are the following
approved status can only set if first_factor and second_factor are presentfirst_factor and second_factor can not be identical, must be different from one to anotherpending status can be updatedIn card processing there are several services that merchants use that is partnered with the card association which offers authentication services on e-commerce transactions. Services like 3DS are used by merchants so that they can reduce their chargeback risk when selling their goods and services. Whenever such services are used by the merchant, the network communicates to Swipe and an entity_card_authentication is created. From this record the client is able to coordinate with the user and validate the purchase attempt before it even happened, thus reducing risk of fraud overall. Depending on each type of authentication certain validation factors are required so that the authentication is successfully sent back to the network. Currently only 3ds is supported for authentication.
Entity Card Authentication Object
\n","_postman_id":"f98ae942-2fb2-4574-a619-6e7e49eb85c6"},{"name":"Funding","item":[{"name":"Query Fund By ID","event":[{"listen":"prerequest","script":{"id":"2939e3fa-b3aa-475e-91ad-a7918a731578","exec":[""],"type":"text/javascript"}}],"id":"64b273a0-d8f9-42e2-84e5-b44f9f067e44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entityCards/4","description":"GET the information of a fund
\n","urlObject":{"path":["api","v2","entityCards","4"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"713b6650-d523-4c5c-993d-5b046809a6af","name":"Query Fund By ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/api/v2/funds/13"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Jul 2020 05:25:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9994"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"041bbae14d0000117d331c4200000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5b72fa7baf52117d-MIA"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 13,\n \"entity_id\": 4,\n \"asset_id\": 4,\n \"total\": \"998873.670000000\",\n \"pending\": \"0.000000000\",\n \"reserved\": \"0.000000000\",\n \"available\": \"998873.670000000\",\n \"favorite\": 0,\n \"inactive\": 0,\n \"created_at\": \"2020-06-22 04:07:30.612721\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-07-22 11:45:58.008676\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1\n }\n}"}],"_postman_id":"64b273a0-d8f9-42e2-84e5-b44f9f067e44"}],"id":"c8679bdf-f622-4d2a-b789-e10367537c09","description":"Every card program supported by our system is funded by an individual funding account. Whenever funds are deposited or withdrawn (due to card usage or payment of fees), the funding account will reflect the currently available balance in real time. It is important to always keep the balance of the funding account to an amount that represents the total volume of card usage. Whenever a card authorization comes in, the funding account is the first check that is done before routing the authorizaiton decision to the client, in case there is insufficient funds to cover the authorizaiton in the funding account, the authorization will be declined instantly, not triggering the authorization request to the client at all.
\n","_postman_id":"c8679bdf-f622-4d2a-b789-e10367537c09"},{"name":"Rewards","item":[{"name":"Create Entity Card Reward","event":[{"listen":"prerequest","script":{"id":"f8e25058-ce92-4ab2-ab1e-f8514fc41468","exec":[""],"type":"text/javascript"}}],"id":"1be93f5e-9b45-4b76-93cf-c47b522c04c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"card_reward_id\": 1,\n \"entity_card_id\": 35065\n}"},"url":"{{url}}/api/v2/entityCardRewards","description":"When creating an entity card reward you are basically linking the card to the MOGL reward network, which will from herein have every card transaction watched for eligibility on the offers it activated.
\nEntity Card Reward Object
\n","urlObject":{"path":["api","v2","entityCardRewards"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"351e4e1e-943a-4f6f-a073-5f1bb65ca6e7","name":"Create Entity Card Reward","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"card_reward_id\": 1,\n \"entity_card_id\": 35065\n}"},"url":"{{url}}/api/v2/entityCardRewards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Nov 2020 16:33:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"289"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9983"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"entity_card_id\": 35065,\n \"card_reward_id\": 1,\n \"reference\": \"19448616\",\n \"status\": \"enabled\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-22 16:33:28.840113\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-22 16:33:28.840113\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n }\n}"}],"_postman_id":"1be93f5e-9b45-4b76-93cf-c47b522c04c8"},{"name":"Create Entity Card Reward Offer","event":[{"listen":"prerequest","script":{"id":"4550cab5-786a-4507-9963-977dae2bc21c","exec":[""],"type":"text/javascript"}}],"id":"dcf03116-6dab-4dd5-876b-4004a4e3112e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"entity_card_reward_id\": 2,\n \"card_reward_offer_id\": 11898\n}"},"url":"{{url}}/api/v2/entityCardRewardOffers","description":"When creating an entity card reward offer you are basically linking the card to an offer from a merchant available in the MOGL reward network, which will basically watch all the transactions done in the merchant offering such offer, if any eligible transaction happen, the cashback reward will be paid as per terms of the offer.
\nEntity Card Reward Object
\n","urlObject":{"path":["api","v2","entityCardRewardOffers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b8b41f82-5432-4301-b1f3-8bd026cf423f","name":"Create Entity Card Reward Offer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n\t\"entity_card_reward_id\": 2,\n \"card_reward_offer_id\": 11898\n}"},"url":"{{url}}/api/v2/entityCardRewardOffers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Nov 2020 16:35:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"302"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9975"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"entity_card_reward_id\": 2,\n \"card_reward_offer_id\": 11898,\n \"reference\": \"15122229\",\n \"status\": \"enabled\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-22 16:35:41.777634\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-22 16:35:41.777634\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n }\n}"}],"_postman_id":"dcf03116-6dab-4dd5-876b-4004a4e3112e"},{"name":"Get Card Reward Transaction List","event":[{"listen":"prerequest","script":{"id":"f79bb4e1-4461-4e71-a4b5-62648ba54475","exec":[""],"type":"text/javascript"}}],"id":"c15763b0-a47d-47c8-b4fe-5a3d2d9da4a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/cardRewardTransactions","description":"GET a list of card reward transactions
\nCard Reward Transaction Object
\n","urlObject":{"path":["api","v2","cardRewardTransactions"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c15763b0-a47d-47c8-b4fe-5a3d2d9da4a5"},{"name":"Get Card Reward Merchant List","event":[{"listen":"prerequest","script":{"id":"1b7e11fc-e5e8-4224-b340-61abc4548c18","exec":[""],"type":"text/javascript"}}],"id":"a0bf6878-d71b-494b-9fb0-6262fe7d168b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/cardRewardMerchants?distance[latitude]=26.024577&distance[longitude]=-80.243429&distance[radius]=10","description":"GET a list of card reward merchants, a specific filter is available so that filtering is also possible through the distance by providing the latitude and longitude (exact user location) and and the radius (in miles). All other fields are filterable using the standard filtering parameters (and, or, etc.).
\nCard Reward Merchant Object
\n","urlObject":{"path":["api","v2","cardRewardMerchants"],"host":["{{url}}"],"query":[{"key":"distance[latitude]","value":"26.024577"},{"key":"distance[longitude]","value":"-80.243429"},{"key":"distance[radius]","value":"10"}],"variable":[]}},"response":[{"id":"766bac17-b247-4e0b-a1a7-c688cc0de0d9","name":"Get Card Reward Merchant List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":{"raw":"{{url}}/api/v2/cardRewardMerchants?distance[latitude]=26.024577&distance[longitude]=-80.243429&distance[radius]=10","host":["{{url}}"],"path":["api","v2","cardRewardMerchants"],"query":[{"key":"distance[latitude]","value":"26.024577"},{"key":"distance[longitude]","value":"-80.243429"},{"key":"distance[radius]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Nov 2020 17:22:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"10000"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2947,\n \"card_reward_id\": 1,\n \"reference\": \"117760\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"7871 Pines Boulevard\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33024\",\n \"phone\": \"(954) 987-7933\",\n \"rating\": \"2\",\n \"rating_count\": \"18\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.009609222412\",\n \"longitude\": \"-80.244987487793\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:35:58.068509\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:35:58.068509\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 1.6705616917886728\n },\n {\n \"id\": 2963,\n \"card_reward_id\": 1,\n \"reference\": \"117776\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"8913 Taft Street\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33024\",\n \"phone\": \"(954) 431-4320\",\n \"rating\": \"2\",\n \"rating_count\": \"16\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.023620605469\",\n \"longitude\": \"-80.264808654785\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:36:04.309133\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:36:04.309133\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 2.1375752596182025\n },\n {\n \"id\": 2962,\n \"card_reward_id\": 1,\n \"reference\": \"117775\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"5901 South University Drive\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33328\",\n \"phone\": \"(954) 434-8832\",\n \"rating\": \"2\",\n \"rating_count\": \"14\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.046840667725\",\n \"longitude\": \"-80.252311706543\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:36:03.921277\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:36:03.921277\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 2.6282251654293685\n },\n {\n \"id\": 1381,\n \"card_reward_id\": 1,\n \"reference\": \"112985\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/112985/pizza-ricca1983064101-thumb.jpg\",\n \"name\": \"Pizza Ricca\",\n \"description\": \"Pizza Ricca is currently located at 5226 South State Road 7, Hollywood, FL 33314. Order your favorite pizza, pasta, salad, and more, all with the click of a button. Pizza Ricca accepts orders online for pickup and delivery.\",\n \"address\": \"5226 S State Road 7\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33314\",\n \"phone\": \"(954) 395-1136\",\n \"rating\": \"4.5\",\n \"rating_count\": \"18\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.056446075439\",\n \"longitude\": \"-80.207427978516\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:25:57.639770\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:25:57.639770\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 5.0460143898918925\n },\n {\n \"id\": 2961,\n \"card_reward_id\": 1,\n \"reference\": \"117774\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"11298 Pines Boulevard\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33026\",\n \"phone\": \"(954) 435-1558\",\n \"rating\": \"1.5\",\n \"rating_count\": \"23\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.00724029541\",\n \"longitude\": \"-80.297981262207\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:36:03.527839\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:36:03.527839\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 5.778477387593358\n },\n {\n \"id\": 280,\n \"card_reward_id\": 1,\n \"reference\": \"37123\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/37120/hallmark96722064-thumb.jpg\",\n \"name\": \"AMY'S HALLMARK SHOP #385\",\n \"description\": \"Hallmark Gold Crown stores feature the largest selection of Hallmark greeting cards and gift wrap as well as Keepsake ornaments, home decor, jewelry and other gift products.\",\n \"address\": \"11401 PINES BL #680\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33026\",\n \"phone\": \"(954) 432-4288\",\n \"rating\": \"3\",\n \"rating_count\": \"1\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.00940322876\",\n \"longitude\": \"-80.302917480469\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:18:59.530870\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:18:59.530870\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 6.175429236389392\n },\n {\n \"id\": 12151,\n \"card_reward_id\": 1,\n \"reference\": \"128454\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/128454/gelatys1224080766-thumb.jpg\",\n \"name\": \"Gelatys\",\n \"description\": null,\n \"address\": \"11401 Pines Boulevard\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33026\",\n \"phone\": null,\n \"rating\": \"0\",\n \"rating_count\": \"0\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.010583877563\",\n \"longitude\": \"-80.304649353027\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:38:36.916782\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:38:36.916782\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 6.30834017285814\n },\n {\n \"id\": 10544,\n \"card_reward_id\": 1,\n \"reference\": \"94775\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/94775/velez-latin-fusion-grill304909846-thumb.jpg\",\n \"name\": \"Velez Latin Fusion Grill\",\n \"description\": \"Check out Velez Latin Fusion Grill for perfectly combined bold flavors that make each dish stand out. Come, Eat, Enjoy!\",\n \"address\": \"7740 Nova Dr\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33324\",\n \"phone\": \"(954) 368-6955\",\n \"rating\": \"4.5\",\n \"rating_count\": \"14\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.090309143066\",\n \"longitude\": \"-80.249717712402\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:27:08.839037\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:27:08.839037\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 7.331421035103801\n },\n {\n \"id\": 907,\n \"card_reward_id\": 1,\n \"reference\": \"113915\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/113447/safelite-autoglass1145128899-thumb.jpg\",\n \"name\": \"Safelite AutoGlass\",\n \"description\": \"Safelite can fix that chipped or cracked windshield! https://fixmyglass.safelite.com Offer valid on auto glass services only when you schedule on safelite.com; not valid on insurance claims or commercial/fleet services.\",\n \"address\": \"3205 SW 22nd St\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33023\",\n \"phone\": \"(786) 629-7074\",\n \"rating\": \"3\",\n \"rating_count\": \"38\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"25.991827011108\",\n \"longitude\": \"-80.175506591797\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:22:59.090705\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:22:59.090705\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 7.698116026136238\n },\n {\n \"id\": 7198,\n \"card_reward_id\": 1,\n \"reference\": \"118213\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"3600 Northwest 199th Street\",\n \"city\": \"Opa Locka\",\n \"state\": \"FL\",\n \"zipcode\": \"33056\",\n \"phone\": \"(305) 378-3000\",\n \"rating\": \"0\",\n \"rating_count\": \"0\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"25.95436668396\",\n \"longitude\": \"-80.261276245117\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:03:44.657265\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:03:44.657265\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 8.003205786806483\n },\n {\n \"id\": 3255,\n \"card_reward_id\": 1,\n \"reference\": \"76908\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/76908/giardino-gourmet-salads126213643-thumb.jpg\",\n \"name\": \"Giardino Gourmet Salads\",\n \"description\": \"Giardino Gourmet Salads started back in 2004 in Miami, FL by our founders, Ody and Kenny Lugo. As a former teacher and firefighter, their focus was to bring wholesome foods back on the scene - packaged in a delicious salad and using a wide variety of only the freshest ingredients. What was once a small restaurant in Coral Gables that seated 12 people, today has flourished into a multi-unit operation that still serves a unique and wide array of products with personalized attention, passion and love. Led by a Board of Directors with a combined 100 years of restaurant experience, Giardino Gourmet Salads is now the premier salad concept of South Florida with 12 restaurants throughout Miami Dade and Broward County. In 2016, Giardino grows out of state for the first time to Nashville, TN and Raleigh, NC. With the same passion from when our founders started this concept, our Gardener Chefs continue to serve hand-crafted, great-tasting salads and gourmet menu offerings.\",\n \"address\": \"1906 S University Dr\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33324\",\n \"phone\": \"(954) 289-3949\",\n \"rating\": \"4.5\",\n \"rating_count\": \"98\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.09662437439\",\n \"longitude\": \"-80.250900268555\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:37:55.943188\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:37:55.943188\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 8.040937174943124\n },\n {\n \"id\": 2950,\n \"card_reward_id\": 1,\n \"reference\": \"117763\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"4704 Flamingo Road South\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33330\",\n \"phone\": \"(954) 680-4323\",\n \"rating\": \"3\",\n \"rating_count\": \"11\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.061580657959\",\n \"longitude\": \"-80.312759399414\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:35:59.192677\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:35:59.192677\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 8.051337946525642\n },\n {\n \"id\": 3202,\n \"card_reward_id\": 1,\n \"reference\": \"118015\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"Florida Turnpike - Mile Post 94\",\n \"city\": \"West Palm Beach\",\n \"state\": \"FL\",\n \"zipcode\": \"33413\",\n \"phone\": \"(561) 434-1994\",\n \"rating\": \"3\",\n \"rating_count\": \"2\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.091918945312\",\n \"longitude\": \"-80.200691223145\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:37:36.253048\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:37:36.253048\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 8.61416042727504\n },\n {\n \"id\": 144,\n \"card_reward_id\": 1,\n \"reference\": \"11165\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/11165/billy-s-tavern1810451697-thumb.jpg\",\n \"name\": \"Billy's Tavern\",\n \"description\": \"Super casual...super friendly. We know our customers by name!\",\n \"address\": \"8580 W State Rd 84\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33324\",\n \"phone\": \"(954) 475-9464\",\n \"rating\": \"4\",\n \"rating_count\": \"178\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.101905822754\",\n \"longitude\": \"-80.263748168945\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:18:07.929639\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:18:07.929639\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 8.829318805078662\n },\n {\n \"id\": 7169,\n \"card_reward_id\": 1,\n \"reference\": \"118184\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"900 Ives Dairy Road\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zipcode\": \"33179\",\n \"phone\": \"(305) 653-9518\",\n \"rating\": \"2.5\",\n \"rating_count\": \"15\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"25.961944580078\",\n \"longitude\": \"-80.186668395996\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:03:31.756814\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:03:31.756814\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 8.976928411002799\n },\n {\n \"id\": 12198,\n \"card_reward_id\": 1,\n \"reference\": \"128509\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/128509/perry-wings-express1956713529-thumb.jpg\",\n \"name\": \"Perry Wings Express\",\n \"description\": null,\n \"address\": \"18553 Northwest 27th Avenue\",\n \"city\": \"Opa Locka\",\n \"state\": \"FL\",\n \"zipcode\": \"33056\",\n \"phone\": \"(786) 704-9879\",\n \"rating\": \"3\",\n \"rating_count\": \"12\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"25.942949295044\",\n \"longitude\": \"-80.244850158691\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:38:57.067379\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:38:57.067379\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 9.071998795468728\n },\n {\n \"id\": 7171,\n \"card_reward_id\": 1,\n \"reference\": \"118186\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"18750 NW 2nd Ave\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zipcode\": \"33169\",\n \"phone\": \"(305) 652-5831\",\n \"rating\": \"2.5\",\n \"rating_count\": \"12\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"25.946624755859\",\n \"longitude\": \"-80.205795288086\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:03:32.645761\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:03:32.645761\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 9.442993513659658\n },\n {\n \"id\": 11830,\n \"card_reward_id\": 1,\n \"reference\": \"128061\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/128061/sal-s-italian-ristorante924629585-thumb.jpg\",\n \"name\": \"Sal's Italian Ristorante\",\n \"description\": null,\n \"address\": \"14535 Southwest 5th Street\",\n \"city\": \"Hollywood\",\n \"state\": \"FL\",\n \"zipcode\": \"33027\",\n \"phone\": \"(954) 239-0563\",\n \"rating\": \"3.5\",\n \"rating_count\": \"146\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.004230499268\",\n \"longitude\": \"-80.335624694824\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:36:16.929982\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:36:16.929982\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 9.480798492253037\n },\n {\n \"id\": 7175,\n \"card_reward_id\": 1,\n \"reference\": \"118190\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"17951 N. W. 27th Avenue\",\n \"city\": \"Opa Locka\",\n \"state\": \"FL\",\n \"zipcode\": \"33056\",\n \"phone\": \"(305) 624-8822\",\n \"rating\": \"1.5\",\n \"rating_count\": \"10\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"25.938100814819\",\n \"longitude\": \"-80.244781494141\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 01:03:34.530878\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 01:03:34.530878\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 9.610625605820806\n },\n {\n \"id\": 2951,\n \"card_reward_id\": 1,\n \"reference\": \"117764\",\n \"image\": \"https://d10ukqbetc2okm.cloudfront.net/images/business/116597/burger-king1518721482-thumb.jpg\",\n \"name\": \"Burger King\",\n \"description\": \"Mix n' match two of your Burger King favorites for just five bucks. Choose two from a Whopper, Original Chicken Sandwich, Chicken Fries or Big Fish, for just five dollars. Only at Burger King. BURGER KING restaurants are known for serving high-quality, great-tasting and affordable food. Our commitment to premium ingredients, signature recipes and family-friendly dining experiences is what has defined our brand for over 50 years.\",\n \"address\": \"1255 Nob Hill Road\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"33324\",\n \"phone\": \"(954) 665-2794\",\n \"rating\": \"1.5\",\n \"rating_count\": \"22\",\n \"metro_name\": \"Miami\",\n \"latitude\": \"26.105182647705\",\n \"longitude\": \"-80.282516479492\",\n \"timezone\": \"America/New_York\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 00:35:59.566918\",\n \"created_by_id\": 1,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 00:35:59.566918\",\n \"updated_by_id\": 1,\n \"updated_from_id\": 1,\n \"distance\": 9.77025145977547\n }\n ],\n \"links\": {\n \"first\": \"https://euprd1srvc.cardapi.net/api/v2/cardRewardMerchants?page=1\",\n \"last\": \"https://euprd1srvc.cardapi.net/api/v2/cardRewardMerchants?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://euprd1srvc.cardapi.net/api/v2/cardRewardMerchants\",\n \"per_page\": 50,\n \"to\": 20,\n \"total\": 20\n }\n}"}],"_postman_id":"a0bf6878-d71b-494b-9fb0-6262fe7d168b"},{"name":"Get Entity Card Rewards","event":[{"listen":"prerequest","script":{"id":"64fd6c0c-83f2-46ed-ad24-d2618a4edb8c","exec":[""],"type":"text/javascript"}}],"id":"d6205300-3166-4633-89b3-1f2df395f37f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/entityCardRewards","description":"GET a list of entity card rewards
\n","urlObject":{"path":["api","v2","entityCardRewards"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8f417076-59aa-42ac-b826-966738e0a4b6","name":"Get Entity Card Rewards","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/entityCardRewards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Nov 2020 16:41:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"896"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9974"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"entity_card_id\": 37025,\n \"card_reward_id\": 1,\n \"reference\": \"19425012\",\n \"status\": \"enabled\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 17:24:13.385166\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 17:24:13.385166\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n },\n {\n \"id\": 2,\n \"entity_card_id\": 35065,\n \"card_reward_id\": 1,\n \"reference\": \"19448616\",\n \"status\": \"enabled\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-22 16:33:28.840113\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-22 16:33:28.840113\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n }\n ],\n \"links\": {\n \"first\": \"https://euprd1srvc.cardapi.net/api/v2/entityCardRewards?page=1\",\n \"last\": \"https://euprd1srvc.cardapi.net/api/v2/entityCardRewards?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://euprd1srvc.cardapi.net/api/v2/entityCardRewards\",\n \"per_page\": 50,\n \"to\": 2,\n \"total\": 2\n }\n}"}],"_postman_id":"d6205300-3166-4633-89b3-1f2df395f37f"},{"name":"Get Entity Card Reward Offers","event":[{"listen":"prerequest","script":{"id":"0496febf-0971-4215-92b6-1d20b31c5587","exec":[""],"type":"text/javascript"}}],"id":"085c15e3-596f-4a79-8419-652212371805","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/entityCardRewardOffers","description":"GET a list of entity card reward offers
\n","urlObject":{"path":["api","v2","entityCardRewardOffers"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"50a24267-4c21-4e9e-9293-1e9ef5e98039","name":"Get Entity Card Reward Offers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{authorization}}"}],"url":"{{url}}/api/v2/entityCardRewardOffers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Nov 2020 16:41:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"937"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.29 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"entity_card_reward_id\": 1,\n \"card_reward_offer_id\": 11898,\n \"reference\": \"15106338\",\n \"status\": \"enabled\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-20 17:30:13.095256\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-20 17:30:13.095256\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n },\n {\n \"id\": 2,\n \"entity_card_reward_id\": 2,\n \"card_reward_offer_id\": 11898,\n \"reference\": \"15122229\",\n \"status\": \"enabled\",\n \"inactive\": 0,\n \"created_at\": \"2020-11-22 16:35:41.777634\",\n \"created_by_id\": 2,\n \"created_from_id\": 1,\n \"updated_at\": \"2020-11-22 16:35:41.777634\",\n \"updated_by_id\": 2,\n \"updated_from_id\": 1\n }\n ],\n \"links\": {\n \"first\": \"https://euprd1srvc.cardapi.net/api/v2/entityCardRewardOffers?page=1\",\n \"last\": \"https://euprd1srvc.cardapi.net/api/v2/entityCardRewardOffers?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https://euprd1srvc.cardapi.net/api/v2/entityCardRewardOffers\",\n \"per_page\": 50,\n \"to\": 2,\n \"total\": 2\n }\n}"}],"_postman_id":"085c15e3-596f-4a79-8419-652212371805"}],"id":"4d2f98e7-3c79-4497-980b-5a5b71d952f3","description":"Card rewards is the process of paying out rewards according to how the end user is spending their card. The reward is linked to a series of offers from qualified merchants where the cardholder can spend using their card and in return get paid back a percentage or a flat amount (according to the reward offer) from the amount spent. It is used to incentivize spending. These rewards are offered from a all merchants within the MOGL network. Our system integrates to the network throughout a series of APIs that can be used to offer such perks in your system. The enrollment for this service is done through your relationship manager, and when concluded, you get a card_reward_id which is later used to link cards to the reward network and from there offer the rewards to your cardholders automatically. The flow goes as follows:
entity_card_id and card_reward_id. When this is done, all spending done on that users card will be tracked in the MOGL network (to check for eligibility on reward payout, the entity_card_reward_id should be stored for usage on activating offers.entity_card_reward_id and card_reward_offer_idpending, completed, and failed).We offer a robust solution to fully issue cards and have it work as a true debit card, enabling you to approve or decline user transactions based on the user's balance within your system. You will be able to track the transactions from each of your cardholders, provide features to your users so they can manage their card, and fully issue cards to your users.
\n","_postman_id":"c7d7f6a7-5c4c-4791-9357-86b5e88c6e9d"},{"name":"Crypto","item":[{"name":"Tracking Addresses","item":[{"name":"Query Tracking Addresses List","id":"c9341dd0-20b3-4744-9bb5-bf6ab4971bbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nin\": \"123456789123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/entities/165","description":"GET a list of tracking addresses
\n","urlObject":{"path":["api","v2","entities","165"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c9341dd0-20b3-4744-9bb5-bf6ab4971bbc"},{"name":"Create Tracking Addresses","id":"39a16871-671c-45ab-97ec-6cb86e170b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"entity_id\": 6,\r\n\t\"platform\": \"bittrex\",\r\n\t\"asset_id\": 4\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/trackingAddresses","description":"When creating a tracking address the status will always be pending, it will take about 5 minutes to properly issue and assign the specified entity with a particular tracking address on the asset request. Webhooks will be triggered during all cycles of the tracking address issuance when it's pending.
Tracking addresses are used to properly receive crypto currency deposits. Each tracking address is unique in the blockchain and it can be used to identify the user who is receiving the deposits. Regardless of the tracking address used, the funds will always stay in custody of the partition owner, we do offer individual user fund tracking as well, contact your sales representative in case you are interested.
\nTracking Address Object
\n","event":[{"listen":"prerequest","script":{"id":"ea0f78cd-78b9-4710-82fb-06f0a70ab0f0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a06b4c5d-45d8-44eb-a4f7-729241f9e4b9","type":"text/javascript","exec":[""]}}],"_postman_id":"a6417111-a8e6-4d8d-9c8f-690d1578464f"}],"id":"12f9ed9f-4695-4a2d-8d24-7226db2966d5","description":"We offer crypto currency services for deposits and withdraw of funds. All that is required for the client to do is create a tracking address for thier user, through webhooks, you will be notified of any deposit against that address and the entire cycle of a deposit such as when it becomes available.
\n","event":[{"listen":"prerequest","script":{"id":"ecb3f136-b61c-4a52-a560-01c1f666815a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d61d31e3-238e-4f2a-9d7f-2de796349430","type":"text/javascript","exec":[""]}}],"_postman_id":"12f9ed9f-4695-4a2d-8d24-7226db2966d5"},{"name":"Users","item":[{"name":"Entities Management","item":[{"name":"Query Entity List","event":[{"listen":"prerequest","script":{"id":"6b5fbe24-4e15-4c0d-8602-0b6c8be28d0b","exec":[""],"type":"text/javascript"}}],"id":"6f77073a-3187-4efa-ba45-110bf61fc789","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entities","description":"GET a list of entities
\n","urlObject":{"path":["api","v2","entities"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"944398ee-7f89-4dc6-a547-9feea0c3fef9","name":"Query By Filter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":{"raw":"{{url}}/api/v2/entities?limit=2","host":["{{url}}"],"path":["api","v2","entities"],"query":[{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 22:37:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588b111b9f22feee-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024ac9053d0000feeea0093200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"nin_type\": \"nationalId\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n },\n {\n \"id\": 1,\n \"firstName\": \"Melissa\",\n \"lastName\": \"Jones\",\n \"country\": \"US\",\n \"address\": \"123 Oak St.\",\n \"city\": \"San Bernadino\",\n \"state\": \"CA\",\n \"zipcode\": \"33180\",\n \"nin\": \"987654321\",\n \"nin_type\": \"driverLicense\",\n \"nin_issue_date\": \"2000-01-01\",\n \"nin_exp_date\": \"2025-01-01\",\n \"email\": \"melissa.jones@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n }\n ],\n \"links\": {\n \"first\": \"https://usnvspd1.spendsdk.com/api/v2/entities?page=1\",\n \"last\": \"https://usnvspd1.spendsdk.com/api/v2/entities?page=24334\",\n \"prev\": null,\n \"next\": \"https://usnvspd1.spendsdk.com/api/v2/entities?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 24334,\n \"path\": \"https://usnvspd1.spendsdk.com/api/v2/entities\",\n \"per_page\": \"2\",\n \"to\": 2,\n \"total\": 48667\n }\n}"}],"_postman_id":"6f77073a-3187-4efa-ba45-110bf61fc789"},{"name":"Query Entity by ID","event":[{"listen":"prerequest","script":{"id":"9fbd5f19-0178-45a5-85b7-7db785b4afc2","exec":[""],"type":"text/javascript"}}],"id":"1718171f-05ca-4fb1-9fed-205e5ab1564b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entities/{{entityId}}","description":"GET information of an entity
\n","urlObject":{"path":["api","v2","entities","{{entityId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"60d7e9cf-2755-4002-a6ae-1a777df6d63a","name":"Query By Filter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{url}}/api/v2/entities?limit=2","host":["{{url}}"],"path":["api","v2","entities"],"query":[{"key":"limit","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 23 Apr 2020 22:37:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588b111b9f22feee-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024ac9053d0000feeea0093200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n }\n}"}],"_postman_id":"1718171f-05ca-4fb1-9fed-205e5ab1564b"},{"name":"Update Entity","event":[{"listen":"prerequest","script":{"id":"0ff6c58f-2219-4b57-b79f-a20b013f0f2f","exec":[""],"type":"text/javascript"}}],"id":"053b2cac-885f-45ce-b70c-0d6bc8c06164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"nin_type\": \"nationalId\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"inactive\": 0\n}"},"url":"{{url}}/api/v2/entities/{{entityId}}","description":"The entity profile data can be updated anytime throughout the entire life cycle of the user within the platform. There are restrictions against the possible fields that can be updated, each updated field related to the user's name, address, personal information such as birthdate and date, will trigger another KYC run, if the user is already in tier 2 completed, it can be downgraded in case it reaches KYC failure. The fields available to update are:
\nEntity Updatable Data
\n","urlObject":{"path":["api","v2","entities","{{entityId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"932d9e3f-1709-4b9e-94dc-488e3a3ab665","name":"Update Entity","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"inactive\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/entities/{{entityId}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"success\": true,\n\t\"data\": {\n \"id\": 1,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"country\": \"US\",\n \"address\": \"123 Elm St.\",\n \"city\": \"Somewhere\",\n \"state\": \"FL\",\n \"zipcode\": \"33180\",\n \"nin\": \"123456789\",\n \"email\": \"john.doe@venus.com\",\n \"birthdate\": \"1998-10-08\",\n \"phone\": \"+19544884203\",\n \"tierLevel\": 2,\n \"tierStatus\": \"completed\",\n \"inactive\": 0\n }\n}"}],"_postman_id":"053b2cac-885f-45ce-b70c-0d6bc8c06164"},{"name":"Create Entity","event":[{"listen":"prerequest","script":{"id":"e85ffac9-f208-4cc7-96d7-84c81ac5590a","exec":[""],"type":"text/javascript"}}],"id":"a0971afe-4c57-43ee-8be0-8985d6d54e81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"country\": \"US\",\r\n \"address\": \"123 Elm St.\",\r\n \"city\": \"Somewhere\",\r\n \"state\": \"FL\",\r\n \"zipcode\": \"33180\",\r\n \"nin\": \"123456789\",\r\n \"nin_type\": \"nationalId\",\r\n \"email\": \"john.doe@venus.com\",\r\n \"birthdate\": \"1998-10-08\",\r\n \"phone\": \"+19544884203\",\r\n \"inactive\": 0\r\n}"},"url":"{{url}}/api/v2/entities","description":"When creating an entity, it is recommended to send as much information as possible for the user, the tier 2 verification will only be triggered once all of the below fields are met. It is possible to send the entity documents nested on the same request, therefore, sending all the entity information and documentation. By doing this, the entity will instantly run through KYC and if approved, be sent to tier 2 completed status directly. If the entity is not instantly approved, a verification record will be created to aid on the results from the KYC run, check on the Risk section for more details.
\nEntity Create Data
\n","urlObject":{"path":["api","v2","entities"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"36c3f187-5df2-487e-b8ad-d79354945df8","name":"Create Entity","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"country\": \"US\",\r\n \"address\": \"123 Elm St.\",\r\n \"city\": \"Somewhere\",\r\n \"state\": \"FL\",\r\n \"zipcode\": \"33180\",\r\n \"nin\": \"123456789\",\r\n \"email\": \"john.doe@venus.com\",\r\n \"birthdate\": \"1998-10-08\",\r\n \"phone\": \"+19544884203\",\r\n \"inactive\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/entities"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"data\": {\r\n \"id\": 1,\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"country\": \"US\",\r\n \"address\": \"123 Elm St.\",\r\n \"city\": \"Somewhere\",\r\n \"state\": \"FL\",\r\n \"zipcode\": \"33180\",\r\n \"nin\": \"123456789\",\r\n \"email\": \"john.doe@venus.com\",\r\n \"birthdate\": \"1998-10-08\",\r\n \"phone\": \"+19544884203\",\r\n \"tierLevel\": 2,\r\n \"tierStatus\": \"completed\",\r\n \"inactive\": 0,\r\n \"documents\": [\r\n \t{\r\n \t\t\"type\": \"documentFront\",\r\n \t\t\"path\": \"data:image/jpeg;base64,/9j/2...\"\r\n \t},\r\n \t{\r\n \t\t\"type\": \"documentBack\",\r\n \t\t\"path\": \"data:image/jpeg;base64,/9j/2...\"\r\n \t}\r\n ]\r\n }\r\n}"}],"_postman_id":"a0971afe-4c57-43ee-8be0-8985d6d54e81"},{"name":"Delete Entity","event":[{"listen":"prerequest","script":{"id":"797ae0a9-3d1d-4e9c-8dbe-2454ed9d4003","exec":[""],"type":"text/javascript"}}],"id":"28133d41-25bd-4154-8ce1-4bcd674f3bed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/api/v2/entities/{{entityId}}","description":"Entities that have no cards are deletable, the ones that ever had cards in the past can not be deleted.
\n","urlObject":{"path":["api","v2","entities","{{entityId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0e376fbe-7a46-464a-a25c-5b638f53dacf","name":"Delete Entity","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{url}}/api/v2/entities/{{entityId}}"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"success\": true\n}"}],"_postman_id":"28133d41-25bd-4154-8ce1-4bcd674f3bed"}],"id":"c586395a-5685-4314-ac59-7df521e1461f","description":"Creating entities will create a user on the Card platform. All created users go through KYC automatically once all their information is provided. Check the risk section to understand how the verification works and possible scenarios.
GET the list of entity documents
\n","urlObject":{"path":["api","v2","entityDocuments"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1dbaf2b5-6fe6-4130-a50e-3183712d8f8c","name":"Entity Documents List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"}],"url":"{{url}}/api/v2/entityDocuments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Apr 2020 01:00:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588be2c25d4dfec6-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024b4c0d730000fec6770d3200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"entity_id\": 3704,\n \"type\": \"personalId\",\n \"path\": \"https://s3.amazonaws.com/assets.spendsdk.com/entities/3704/3bf55ec7ae8f94.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIASC7EDEPSFFMXZQ%2F20200424%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200424T010010Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=0d41dfb3047bd7c716a0b926955d4dac80f1ba62ce625b6e6fdbf9c17b69a689\",\n \"created_at\": \"2019-01-10 13:08:49\",\n \"updated_at\": \"2019-01-10 13:08:49\"\n },\n {\n \"id\": 2,\n \"entity_id\": 3704,\n \"type\": \"personalId\",\n \"path\": \"https://s3.amazonaws.com/assets.spendsdk.com/entities/3704/9ff43d7df06d0e.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIASC7EDEPSFFMXZQ%2F20200424%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200424T010010Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=d5eb3768d26f472cad484f69ff1b11b93e1ead9d60084b07f6b060383eb53889\",\n \"created_at\": \"2019-01-10 13:08:50\",\n \"updated_at\": \"2019-01-10 13:08:50\"\n },\n {\n \"id\": 3,\n \"entity_id\": 3287,\n \"type\": \"personalId\",\n \"path\": \"https://s3.amazonaws.com/assets.spendsdk.com/entities/3287/9146128ed21f32.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIASC7EDEPSFFMXZQ%2F20200424%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200424T010010Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=02bf59986959dc34405975f7a83b87aafbdf363ef655f3aed0fb648d7ce15ec6\",\n \"created_at\": \"2019-01-10 15:11:26\",\n \"updated_at\": \"2019-01-10 15:11:26\"\n },\n {\n \"id\": 4,\n \"entity_id\": 3287,\n \"type\": \"personalId\",\n \"path\": \"https://s3.amazonaws.com/assets.spendsdk.com/entities/3287/2c42bc729279a9.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIASC7EDEPSFFMXZQ%2F20200424%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200424T010010Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=9da6a5d495d509d0a285bae460e9a951440083643d157a6cf334f1558925f1ff\",\n \"created_at\": \"2019-01-10 15:42:37\",\n \"updated_at\": \"2019-01-10 15:42:37\"\n }\n ],\n \"links\": {\n \"first\": \"https://usnvspd1.spendsdk.com/api/v2/entityDocuments?page=1\",\n \"last\": \"https://usnvspd1.spendsdk.com/api/v2/entityDocuments?page=1159\",\n \"prev\": null,\n \"next\": \"https://usnvspd1.spendsdk.com/api/v2/entityDocuments?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1159,\n \"path\": \"https://usnvspd1.spendsdk.com/api/v2/entityDocuments\",\n \"per_page\": 50,\n \"to\": 50,\n \"total\": 57929\n }\n}"}],"_postman_id":"f058bd88-d527-4de3-b11e-102339278d9c"},{"name":"Query Entity Document By ID","event":[{"listen":"prerequest","script":{"id":"bbb6e4a0-5d3f-4b0d-b33c-834456a46f57","exec":[""],"type":"text/javascript"}}],"id":"31b1ebf6-2684-44ea-819f-412a63f3747d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url}}/api/v2/entityDocuments/{{entityDocumentId}}","description":"GET information about a specific entity card document
\n","urlObject":{"path":["api","v2","entityDocuments","{{entityDocumentId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"07554410-17bb-423d-aad0-42b5035a3264","name":"Entity Documents By Entity ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"}],"url":"{{url}}/api/v2/entityDocuments/50"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Apr 2020 01:02:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588be64a4dfefec6-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024b4e42680000fec6770c1200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 50,\n \"entity_id\": 3746,\n \"type\": \"personalId\",\n \"path\": \"https://s3.amazonaws.com/assets.spendsdk.com/entities/3746/956d94006b5344.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIASC7EDEPSFFMXZQ%2F20200424%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200424T010234Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=3807d370511f6c37d05f73976a8ee9999837cb7405f4a6f7f05bd71715d4d0e9\",\n \"created_at\": \"2019-01-11 17:56:57\",\n \"updated_at\": \"2019-01-11 17:56:57\"\n }\n}"}],"_postman_id":"31b1ebf6-2684-44ea-819f-412a63f3747d"},{"name":"Create Entity Document","event":[{"listen":"prerequest","script":{"id":"a2279f8a-3a51-4670-9eb8-7cd2dc34b09e","exec":[""],"type":"text/javascript"}}],"id":"17a38dcf-7d0a-4593-8c1d-160abba0efab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n \"entity_id\": 26,\n \"type\": \"general\",\n \"path\": \"data:image/jpeg;base64,/9j/2wBDAAYEBQYFBAYGBQ...\"\n}"},"url":"{{url}}/api/v2/entityDocuments","description":"When creating an entity card document, if the entity already had the same type of document before, the newly created document will dispose of the old one. In case the entity is not tier 2 completed yet, once created, it will also trigger a KYC run if the entity is meeting all needed requirements.
DELETE the entity card document
\n","urlObject":{"path":["api","v2","entityDocuments","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"ceb5360f-f609-4427-b444-f7f75db66215","name":"Entity Document Delete","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{authorization}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{url}}/api/v2/entityDocuments/{{entityDocumentId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Apr 2020 01:05:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9995"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588bea905f85fec6-IAH"},{"key":"cf-request-id","value":"024b50ee340000fec6770ee200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"55be9f3b-4d21-41b0-b24b-0c083790d272"}],"id":"01aecc5a-7cca-4832-bd83-e75c62f8378c","description":"To comply with the regulation in several regions, it is required that the entity sends in documentation to prove their identity prior to issuing a card. Using the entity documents APIs give flexibility to the issuer so that they can easily send in documents. When the document image is queried, it will be possible to view the image with a temporary link, which is only valid for 5 minutes.
\nEntity Document Object
\n","_postman_id":"01aecc5a-7cca-4832-bd83-e75c62f8378c"}],"id":"d50fff90-2902-4def-b4be-050ce90a6fd7","description":"Every card in our system is owned by an entity. The entity record will hold all necessary user information so that they are in compliance with local and international government authority regulations and as well as all needed requirements to be in compliance with the bank and the card brand networks. To do that, our system uses a simple tier level tracking system from 1-2, where 1 means that the user passed all internal checks and 2 means that the user passed all KYC, OFAC, and fraud checks through third-party verification. Only after the entity is at tier level 2 with completed status, is that they will be eligible to apply for a card. Our system makes it easy for the issuer to track this verification process, check out the Risk section for more details.
Entity Object
\n","event":[{"listen":"prerequest","script":{"id":"bd92f208-626a-41c2-ba24-9d44e38bea79","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bc15f360-5f75-46b7-ad4c-0b7c1de7905f","type":"text/javascript","exec":[""]}}],"_postman_id":"d50fff90-2902-4def-b4be-050ce90a6fd7"},{"name":"Risk","item":[{"name":"Verifications","item":[{"name":"Query Verification List","event":[{"listen":"prerequest","script":{"id":"a567ccfa-479c-4dd2-8050-c65bd2dcc65b","exec":[""],"type":"text/javascript"}}],"id":"1d3a8f57-e2ad-47f6-90b6-e8a237912087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{url}}/api/v2/verifications?with[]=results","description":"GET a list of verifications
\n","urlObject":{"path":["api","v2","verifications"],"host":["{{url}}"],"query":[{"key":"with[]","value":"results"}],"variable":[]}},"response":[{"id":"143fe8f8-95a6-4814-bfd8-a62defb6af8a","name":"Query Verification List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{url}}/api/v2/verifications?with[]=results","host":["{{url}}"],"path":["api","v2","verifications"],"query":[{"key":"with[]","value":"results"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Apr 2020 03:13:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588ca58d5b11fec2-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024bc5cc5b0000fec2b1069200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 43,\n \"parent_id\": 13629,\n \"parent_type\": \"App\\\\Entity\",\n \"decision_id\": 55,\n \"type\": \"entityIdentity\",\n \"score\": 60,\n \"description\": \"Entity verification for user John Doe from trulioo\",\n \"reference\": \"2062c44d-518d-37b9-3f72-1158d3c1bd6f\",\n \"data\": \"{\\\"TransactionID\\\":\\\"37b1738d-ebd9-4420-8253-103e3c1d3882\\\",\\\"UploadedDt\\\":\\\"2020-03-10T00:57:35\\\",\\\"CountryCode\\\":\\\"US\\\",\\\"ProductName\\\":\\\"Identity Verification\\\",\\\"Record\\\":{\\\"TransactionRecordID\\\":\\\"2062c44d-518d-37b9-3f72-1158d3c1bd6f\\\",\\\"RecordStatus\\\":\\\"match\\\",\\\"DatasourceResults\\\":[{\\\"DatasourceName\\\":\\\"Credit Agency 2\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"DayOfBirth\\\",\\\"Status\\\":\\\"nomatch\\\"},{\\\"FieldName\\\":\\\"MonthOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"socialservice\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleInitial\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"FraudFlag\\\",\\\"Data\\\":\\\"False\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Driver License\\\",\\\"DatasourceFields\\\":[],\\\"AppendedFields\\\":[],\\\"Errors\\\":[{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: DriverLicenceNumber\\\"},{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: DriverLicenceState\\\"}],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Enhanced Credit 1\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"DayOfBirth\\\",\\\"Status\\\":\\\"nomatch\\\"},{\\\"FieldName\\\":\\\"MonthOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"nomatch\\\"},{\\\"FieldName\\\":\\\"socialservice\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleInitial\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"DriverLicenceNumber\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MinimumAge\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"DriverLicenceState\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"FraudFlag\\\",\\\"Data\\\":\\\"False\\\"},{\\\"FieldName\\\":\\\"IsDeceased\\\",\\\"Data\\\":\\\"False\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"International Watchlist\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"WatchlistState\\\",\\\"Data\\\":\\\"Clear\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Passport MRZ Validation\\\",\\\"DatasourceFields\\\":[],\\\"AppendedFields\\\":[],\\\"Errors\\\":[{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: PassportMRZLine1\\\"},{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: PassportMRZLine2\\\"}],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Resident Files\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleInitial\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"AddressAssociation\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Telephone File\\\",\\\"DatasourceFields\\\":[],\\\"AppendedFields\\\":[],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Utility\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"DayOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MonthOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"FraudFlag\\\",\\\"Data\\\":\\\"False\\\"},{\\\"FieldName\\\":\\\"IsDeceased\\\",\\\"Data\\\":\\\"False\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]}],\\\"Errors\\\":[],\\\"Rule\\\":{\\\"RuleName\\\":\\\"Category 3 KYC v3\\\",\\\"Note\\\":\\\"Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored\\\"}},\\\"CustomerReferenceID\\\":\\\"13629\\\",\\\"Errors\\\":[]}\\nAccess Denied\",\n \"attempts\": 3,\n \"status\": \"pending\",\n \"created_at\": \"2019-02-27 22:07:04\",\n \"updated_at\": \"2020-03-10 00:57:41\",\n \"results\": [\n {\n \"id\": 62052,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FirstSurName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62053,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FirstGivenName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62054,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"StateProvinceCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62055,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"PostalCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62056,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"DayOfBirth\",\n \"message\": \"nomatch\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62057,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"MonthOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62058,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"YearOfBirth\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62059,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"socialservice\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62060,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"Telephone\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62061,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"City\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62062,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"UnitNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62063,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"BuildingNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62064,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"StreetName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62065,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"StreetType\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62066,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FirstInitial\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62067,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"MiddleName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62068,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"MiddleInitial\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62069,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FraudFlag\",\n \"message\": \"False\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62070,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"FirstSurName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62071,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"FirstGivenName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62072,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"StateProvinceCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62073,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"PostalCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n }\n ]\n }\n ],\n \"error\": [],\n \"links\": {\n \"first\": \"https://usnvspd1.spendsdk.com/api/v2/verifications?page=1\",\n \"last\": \"https://usnvspd1.spendsdk.com/api/v2/verifications?page=250\",\n \"prev\": null,\n \"next\": \"https://usnvspd1.spendsdk.com/api/v2/verifications?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 250,\n \"path\": \"https://usnvspd1.spendsdk.com/api/v2/verifications\",\n \"per_page\": 50,\n \"to\": 50,\n \"total\": 12480\n }\n}"}],"_postman_id":"1d3a8f57-e2ad-47f6-90b6-e8a237912087"},{"name":"Query Verification for Entity","event":[{"listen":"prerequest","script":{"id":"7b7a1e08-6c2e-4e81-bdec-3ddb95bb020a","exec":[""],"type":"text/javascript"}}],"id":"0dafdca1-791b-411e-ab7b-482dba348fd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{url}}/api/v2/entities?and[id][][eq]={{entityId}}&with[]=verifications","description":"GET information of a specific verification through the entity id. This is very useful when the issuer wants to check if the specific entity has a pending verification record, for example, it can also make it easier to look up KYC results for a specific entity.
GET information of a specific verification
\n","urlObject":{"path":["api","v2","verifications","1344"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"799d7627-5843-429c-9260-5007569714c7","name":"Query Verification by ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"url":"{{url}}/api/v2/verifications/{{verificationId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Apr 2020 03:28:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"588cbb9c4df8fece-IAH"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-request-id","value":"024bd395b00000fece0c264200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 43,\n \"parent_id\": 13629,\n \"parent_type\": \"App\\\\Entity\",\n \"decision_id\": 55,\n \"type\": \"entityIdentity\",\n \"score\": 60,\n \"description\": \"Entity verification for username John Doe from trulioo\",\n \"reference\": \"2062c44d-518d-37b9-3f72-1158d3c1bd6f\",\n \"data\": \"{\\\"TransactionID\\\":\\\"37b1738d-ebd9-4420-8253-103e3c1d3882\\\",\\\"UploadedDt\\\":\\\"2020-03-10T00:57:35\\\",\\\"CountryCode\\\":\\\"US\\\",\\\"ProductName\\\":\\\"Identity Verification\\\",\\\"Record\\\":{\\\"TransactionRecordID\\\":\\\"2062c44d-518d-37b9-3f72-1158d3c1bd6f\\\",\\\"RecordStatus\\\":\\\"match\\\",\\\"DatasourceResults\\\":[{\\\"DatasourceName\\\":\\\"Credit Agency 2\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"DayOfBirth\\\",\\\"Status\\\":\\\"nomatch\\\"},{\\\"FieldName\\\":\\\"MonthOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"socialservice\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleInitial\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"FraudFlag\\\",\\\"Data\\\":\\\"False\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Driver License\\\",\\\"DatasourceFields\\\":[],\\\"AppendedFields\\\":[],\\\"Errors\\\":[{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: DriverLicenceNumber\\\"},{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: DriverLicenceState\\\"}],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Enhanced Credit 1\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"DayOfBirth\\\",\\\"Status\\\":\\\"nomatch\\\"},{\\\"FieldName\\\":\\\"MonthOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"nomatch\\\"},{\\\"FieldName\\\":\\\"socialservice\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleInitial\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"DriverLicenceNumber\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MinimumAge\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"DriverLicenceState\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"FraudFlag\\\",\\\"Data\\\":\\\"False\\\"},{\\\"FieldName\\\":\\\"IsDeceased\\\",\\\"Data\\\":\\\"False\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"International Watchlist\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"WatchlistState\\\",\\\"Data\\\":\\\"Clear\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Passport MRZ Validation\\\",\\\"DatasourceFields\\\":[],\\\"AppendedFields\\\":[],\\\"Errors\\\":[{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: PassportMRZLine1\\\"},{\\\"Code\\\":\\\"1001\\\",\\\"Message\\\":\\\"Missing required field: PassportMRZLine2\\\"}],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Resident Files\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"MiddleName\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MiddleInitial\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"AddressAssociation\\\",\\\"Status\\\":\\\"missing\\\"}],\\\"AppendedFields\\\":[],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Telephone File\\\",\\\"DatasourceFields\\\":[],\\\"AppendedFields\\\":[],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]},{\\\"DatasourceName\\\":\\\"Utility\\\",\\\"DatasourceFields\\\":[{\\\"FieldName\\\":\\\"FirstSurName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstGivenName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StateProvinceCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"PostalCode\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"DayOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"MonthOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"YearOfBirth\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"Telephone\\\",\\\"Status\\\":\\\"missing\\\"},{\\\"FieldName\\\":\\\"City\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"UnitNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"BuildingNumber\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetName\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"StreetType\\\",\\\"Status\\\":\\\"match\\\"},{\\\"FieldName\\\":\\\"FirstInitial\\\",\\\"Status\\\":\\\"match\\\"}],\\\"AppendedFields\\\":[{\\\"FieldName\\\":\\\"FraudFlag\\\",\\\"Data\\\":\\\"False\\\"},{\\\"FieldName\\\":\\\"IsDeceased\\\",\\\"Data\\\":\\\"False\\\"}],\\\"Errors\\\":[],\\\"FieldGroups\\\":[]}],\\\"Errors\\\":[],\\\"Rule\\\":{\\\"RuleName\\\":\\\"Category 3 KYC v3\\\",\\\"Note\\\":\\\"Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored\\\"}},\\\"CustomerReferenceID\\\":\\\"13629\\\",\\\"Errors\\\":[]}\\nAccess Denied\",\n \"attempts\": 3,\n \"status\": \"pending\",\n \"created_at\": \"2019-02-27 22:07:04\",\n \"updated_at\": \"2020-03-10 00:57:41\",\n \"results\": [\n {\n \"id\": 62052,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FirstSurName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62053,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FirstGivenName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62054,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"StateProvinceCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62055,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"PostalCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62056,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"DayOfBirth\",\n \"message\": \"nomatch\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62057,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"MonthOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62058,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"YearOfBirth\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62059,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"socialservice\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62060,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"Telephone\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62061,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"City\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62062,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"UnitNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62063,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"BuildingNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62064,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"StreetName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62065,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"StreetType\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62066,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FirstInitial\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62067,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"MiddleName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62068,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"MiddleInitial\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62069,\n \"verification_id\": 43,\n \"code\": \"Credit Agency 2\",\n \"field\": \"FraudFlag\",\n \"message\": \"False\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62070,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"FirstSurName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62071,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"FirstGivenName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62072,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"StateProvinceCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62073,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"PostalCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62074,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"DayOfBirth\",\n \"message\": \"nomatch\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62075,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"MonthOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62076,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"YearOfBirth\",\n \"message\": \"nomatch\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62077,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"socialservice\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62078,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"Telephone\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62079,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"City\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62080,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"UnitNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62081,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"BuildingNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62082,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"StreetName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62083,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"StreetType\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62084,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"FirstInitial\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62085,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"MiddleName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62086,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"MiddleInitial\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62087,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"DriverLicenceNumber\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62088,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"MinimumAge\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62089,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"DriverLicenceState\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62090,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"FraudFlag\",\n \"message\": \"False\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62091,\n \"verification_id\": 43,\n \"code\": \"Enhanced Credit 1\",\n \"field\": \"IsDeceased\",\n \"message\": \"False\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62092,\n \"verification_id\": 43,\n \"code\": \"International Watchlist\",\n \"field\": \"FirstSurName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62093,\n \"verification_id\": 43,\n \"code\": \"International Watchlist\",\n \"field\": \"FirstGivenName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62094,\n \"verification_id\": 43,\n \"code\": \"International Watchlist\",\n \"field\": \"YearOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62095,\n \"verification_id\": 43,\n \"code\": \"International Watchlist\",\n \"field\": \"MiddleName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62096,\n \"verification_id\": 43,\n \"code\": \"International Watchlist\",\n \"field\": \"WatchlistState\",\n \"message\": \"Clear\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62097,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"FirstSurName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62098,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"FirstGivenName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62099,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"StateProvinceCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62100,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"PostalCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62101,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"Telephone\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62102,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"City\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62103,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"UnitNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62104,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"BuildingNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62105,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"StreetName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62106,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"StreetType\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62107,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"FirstInitial\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62108,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"MiddleName\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62109,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"MiddleInitial\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62110,\n \"verification_id\": 43,\n \"code\": \"Resident Files\",\n \"field\": \"AddressAssociation\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62111,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"FirstSurName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62112,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"FirstGivenName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62113,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"StateProvinceCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62114,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"PostalCode\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62115,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"DayOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62116,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"MonthOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62117,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"YearOfBirth\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62118,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"Telephone\",\n \"message\": \"missing\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62119,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"City\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62120,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"UnitNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62121,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"BuildingNumber\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62122,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"StreetName\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62123,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"StreetType\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62124,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"FirstInitial\",\n \"message\": \"match\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62125,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"FraudFlag\",\n \"message\": \"False\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n },\n {\n \"id\": 62126,\n \"verification_id\": 43,\n \"code\": \"Utility\",\n \"field\": \"IsDeceased\",\n \"message\": \"False\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-03-10 00:57:41\",\n \"updated_at\": \"2020-03-10 00:57:41\"\n }\n ]\n },\n \"error\": []\n}"}],"_postman_id":"0cf71382-62b1-41c5-8b0e-840f2cdbaf60"}],"id":"79471e32-7a21-471a-981e-feaa786b33fe","description":"Every time our system gathers information that can potentially expose the issuer to any risk it creates a verification record against the resource and compiles information regarding all elements that brought the system to consider it a risky operation. Today we use verifications primarily for entities during KYC run. Since the results of KYC can potentially expose risk to the issuer, we always create verification records to aid the decision making of the issuer and to also handle any wrong information that the user might have provided.
\nVerification Object
\nVerification Result Object
\n","event":[{"listen":"prerequest","script":{"id":"e7072d0f-7c15-489c-afb3-34123bdad421","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28dbab84-f935-432b-9593-795a0be1688f","type":"text/javascript","exec":[""]}}],"_postman_id":"79471e32-7a21-471a-981e-feaa786b33fe"}],"id":"d8885eef-6a2f-4ae6-b787-516dea6ffa87","description":"How is risk analysis done
\nBased on the entity information provided, the documents submitted, and other vendors we are integrated with. The system then groups the minimum required information to initiate the analysis which follows the following flow:
\nTier 1
\nTier 2
\nPossible outcomes from KYC runs
\nverified status instantly and the user also becomes tier 2 completed.pending with all the information needed for the issuer to manually review with the user.Regardless of the verification record being verified, failed, or pending the issuer will always receive a webhook notification containing a full copy of the verification record from the KYC run.
What should I do with the verification record
\nThe first thing to do when a webhook is received for a KYC verification is to check the status. If the status is verified or failed, no further action is needed as both are final. In case it is verified it means the entity is ready to issue cards, as for failed it means the entity did not meet the minimum requirements to have a card issued.
If the status is pending then the issuer should go through the data provided by the verification record and manually resolve the mismatches with the user, once the issuer is ready to properly rerun the KYC, the issuer should simply update the entity with the correct information, that's it, the system will automatically rerun KYC and update the current pending verification record with the updated KYC run information, a webhook is fired whenever the verification records are updated. If on the follow-up runs it passes KYC, then the issuer will receive the same verification record with the new result, score, and with the status set to verified, at this point the user will be tier 2 completed.
Tips and Hints
\nTo improve the automation process, the issuer can implement logic in their ecosystems in a way that when it receives a webhook for a verification record that is verified, it automatically fires a push notification to a frontend app so that it directs the user to the card issuance phase. The issuer can even, on the background, issue the card for the user in a case where the user had a pending verification but got verified afterwards.
The National Identification Number
\nThe National Identification Number, identified in our system as just NIN, is the identification number from a local government authority where the user currently resides. It is used to properly identify the user in private and public databases during the KYC verification process and to validate the user information.
\n","_postman_id":"d8885eef-6a2f-4ae6-b787-516dea6ffa87"},{"name":"Webhooks","item":[{"name":"Alerts","item":[{"name":"Query Alert List","id":"c3c577d3-4390-47a0-af9b-ae08afaee11a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{url}}/api/v2/alerts","description":"GET a list of alerts
\n","urlObject":{"path":["api","v2","alerts"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f1cac8e8-b420-4102-b4f6-01b84afa2eaa","name":"Query Alert List","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{url}}/api/v2/alerts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 May 2020 23:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5927df22c94a7435-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"cf-request-id","value":"02acc9c9c10000743555bc5200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Authorization Webhook\",\n \"type\": \"web\",\n \"event\": \"authorization\",\n \"destination\": \"https://sandboxapi.wallet.com/authorization\",\n \"headers\": null,\n \"response\": 1,\n \"inactive\": 0,\n \"created_at\": \"2020-05-12 23:15:23.000000\",\n \"updated_at\": \"2020-05-12 23:15:23.000000\"\n },\n {\n \"id\": 2,\n \"name\": \"Authorization Webhook\",\n \"type\": \"web\",\n \"event\": \"cardOrder\",\n \"destination\": \"https://sandboxapi.wallet.com/notification\",\n \"headers\": null,\n \"response\": 0,\n \"inactive\": 0,\n \"created_at\": \"2020-05-12 23:16:30.000000\",\n \"updated_at\": \"2020-05-12 23:16:30.000000\"\n }\n ],\n \"links\": {\n \"first\": \"http://bta1stg.cardapi.net/api/v2/alerts?page=1\",\n \"last\": \"http://bta1stg.cardapi.net/api/v2/alerts?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"http://bta1stg.cardapi.net/api/v2/alerts\",\n \"per_page\": 50,\n \"to\": 2,\n \"total\": 2\n }\n}"}],"_postman_id":"c3c577d3-4390-47a0-af9b-ae08afaee11a"},{"name":"Query Alert By ID","id":"eb913314-9008-4744-bcd2-695938a3fd5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{url}}/api/v2/alerts/1","description":"GET information about a specific alert
\n","urlObject":{"path":["api","v2","alerts","1"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2ddbdf5a-b8a6-4e67-8d52-af01676e97b2","name":"Query Alert By ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{url}}/api/v2/alerts/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 May 2020 23:21:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9994"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5927e082598e7435-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"cf-request-id","value":"02accaa5790000743555b42200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"Authorization Webhook\",\n \"type\": \"web\",\n \"event\": \"authorization\",\n \"destination\": \"https://sandboxapi.wallet.com/authorization\",\n \"headers\": null,\n \"response\": 1,\n \"inactive\": 0,\n \"created_at\": \"2020-05-12 23:15:23.000000\",\n \"updated_at\": \"2020-05-12 23:15:23.000000\"\n }\n}"}],"_postman_id":"eb913314-9008-4744-bcd2-695938a3fd5b"},{"name":"Update Alert","id":"870417fa-be51-49fb-a5c6-a3176261259c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New Card Order Webhook\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/alerts/2","description":"Update the alert
\n","urlObject":{"path":["api","v2","alerts","2"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3e2cf252-b83d-4abb-a566-c5d9a6409389","name":"Update Alert","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"New Card Order Webhook\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/v2/alerts/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 12 May 2020 23:23:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"10000"},{"key":"X-RateLimit-Remaining","value":"9998"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"script-src 'self'"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5927e2a7c9f77435-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"cf-request-id","value":"02accbfcdc0000743555bff200000001"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"New Card Order Webhook\",\n \"type\": \"web\",\n \"event\": \"cardOrder\",\n \"destination\": \"https://sandboxapi.wallet.com/notification\",\n \"headers\": null,\n \"response\": 0,\n \"inactive\": 0,\n \"created_at\": \"2020-05-12 23:16:30.000000\",\n \"updated_at\": \"2020-05-12 23:23:05.143725\"\n }\n}"}],"_postman_id":"870417fa-be51-49fb-a5c6-a3176261259c"},{"name":"Create Alerts","event":[{"listen":"prerequest","script":{"id":"40810f51-5a8e-402a-abc1-4402f032dcbc","exec":[""],"type":"text/javascript"}}],"id":"99592676-05b9-46f3-8608-5d2ec99db37e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{authorization}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Authorization Webhook\",\n \"type\": \"web\",\n \"event\": \"cardOrder\",\n \"destination\": \"https://sandboxapi.wallet.com/notification\",\n \"headers\": \"[{\\\"Authorization\\\":,\\\"adf98293u4asd09ugf90u9dsf\\\"}]\"\n}"},"url":"{{url}}/api/v2/alerts","description":"For the creation of alerts, it's important to keep in mind that for alerts that use response back (like an authorization event for example) the flag response must be set to 1, however, only one alert for the same type and event can exist with response set to 1. Therefore, the attempt to create multiple alerts with response set to 1 will fail.
Alerts are records created in our system to properly send out a notification to the configured destination, such as a webhook. Our alert system is event-based and flexible, you can define specific headers that should be sent to the destination as well as create alerts that expect responses. When the event is triggered in our system, it will immediately look for configured alerts to process. All of our alerts will send out a JSON encoded payload containing important information of the data that changed when the event was triggered. An alert is effective as soon as it's created. When creating alerts without responses, it is possible to register multiple notifications of the same type and event, therefore, enabling the alert to be sent over to multiple parties if required.
Alert Object
\n","_postman_id":"a6c7ede1-efd1-4e3e-9db3-2c010bfebac6"},{"name":"Authorizations","item":[{"name":"Authorization request","id":"e1c68cab-67fa-4193-8b71-34bbff508230","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 91255,\n \"from_card_transaction_id\": null,\n \"entity_card_id\": 3350,\n \"transaction_id\": 320527,\n \"merchant\": \"SwipeMerchantMerchant1\",\n \"merchant_address\": null,\n \"merchant_city\": \"Paris\",\n \"merchant_state\": null,\n \"merchant_country\": \"FRA\",\n \"reference\": \"400807\",\n \"authorization\": \"972615\",\n \"mcc\": 5512,\n \"type\": \"auth\",\n \"status\": \"pending\",\n \"currency\": \"EUR\",\n \"local_currency\": null,\n \"local_amount\": null,\n \"exchange_rate\": null,\n \"channel\": null,\n \"pin_present\": 0,\n \"card_present\": 0,\n \"approved\": \"0.000000000\",\n \"total\": \"18.000000000\",\n \"created_at\": \"2020-06-04 23:03:21.589803\",\n \"updated_at\": \"2020-06-04 23:03:23.228959\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"An authorization request is a card transaction type that pre-authorizes and sets a hold on the amount. It's held pending until the merchant settles. The settlement can happen overnight or whenever the merchant sends in the batch of transactions to the bank. The settlement of this type of card transaction should be observed on notifications with card transactions of type capture and the amount maybe lower or more then total amount in case of tips or surcharge.
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1c68cab-67fa-4193-8b71-34bbff508230"},{"name":"Sale request","id":"4c0288a1-7ee2-47e1-b343-2eed57d4bea7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 91255,\n \"from_card_transaction_id\": null,\n \"entity_card_id\": 3350,\n \"transaction_id\": 320527,\n \"merchant\": \"SwipeMerchantMerchant1\",\n \"merchant_address\": null,\n \"merchant_city\": \"Paris\",\n \"merchant_state\": null,\n \"merchant_country\": \"FRA\",\n \"reference\": \"400807\",\n \"authorization\": \"972615\",\n \"mcc\": 5512,\n \"type\": \"sale\",\n \"status\": \"pending\",\n \"currency\": \"EUR\",\n \"local_currency\": null,\n \"local_amount\": null,\n \"exchange_rate\": null,\n \"channel\": null,\n \"pin_present\": 0,\n \"card_present\": 0,\n \"approved\": \"0.000000000\",\n \"total\": \"18.000000000\",\n \"created_at\": \"2020-06-04 23:03:21.589803\",\n \"updated_at\": \"2020-06-04 23:03:23.228959\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"A sale authorization request is a card transaction type that once authorize is immedietly settled once approved. An example of a sale authorization would be an ATM transaction or a merchant that processed the payment with immidiate capture.
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c0288a1-7ee2-47e1-b343-2eed57d4bea7"},{"name":"Approval Response","id":"d064f1d1-29ed-45fb-b897-0b8f96d20124","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": {{cardTransactionID}},\n \"amount\": {{amount}}\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"Must be sent with response code number 200
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d064f1d1-29ed-45fb-b897-0b8f96d20124"},{"name":"Decline Response","id":"4f917c91-dab7-4d9e-8f03-1baa700d8400","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": {{cardTransactionID}},\n \"amount\": {{amount}},\n \"reason_code\": {{Any code defined by the client in string or numbers}},\n \"reason\": \"The user has insufficient balance\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"Must be sent with response code number 204. When sending the decline response the client can also send over the reason_code and/or reason of the decline, in case the reason is sent but the reason_code is missing, the system will default such value to generic. The reason and reason_code will be stored in the card transaction results and can be used to properly define why the client declined such transaction.
Authorizations webhooks are used to provide the issuer with information to approve or decline a specific card transaction. Every time a cardholder uses the card at a merchant (be it online or physically) a webhook will be triggered to the URL on file for the issuer and expect a response. By default, all authorization requests are set to decline unless the response from the issuer instructs otherwise.
\nIt is important that response take no longer than 1 second, to guarantee proper propagation of the approval back to the card brand network.
\n","_postman_id":"07a400c1-3b0c-4321-95ba-98aef9b04fb2"},{"name":"Notifications","item":[{"name":"Capture Request","id":"0c72b564-237a-445a-bd4a-d99400160b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 51744,\n \"from_card_transaction_id\": {{Original card transaction that links to this capture}}, \n \"entity_card_id\": 29,\n \"transaction_id\": null,\n \"merchant\": \"USA*FIVE STAR FOOD\",\n \"merchant_address\": null,\n \"merchant_city\": \"Paris\",\n \"merchant_state\": null,\n \"merchant_country\": \"FRA\",\n \"reference\": \"ad358d42-c490-4d33-be4a-09e82fea45f9\",\n \"authorization\": \"125985\",\n \"mcc\": 5512,\n \"type\": \"capture\",\n \"status\": \"completed\",\n \"currency\": \"USD\",\n \"local_currency\": null,\n \"local_amount\": null,\n \"exchange_rate\": null,\n \"channel\": null,\n \"pin_present\": 0,\n \"card_present\": 0,\n \"approved\": \"1.600000000\",\n \"total\": \"1.600000000\",\n \"created_at\": \"2019-11-04 11:44:18.000000\",\n \"updated_at\": \"2019-11-04 11:44:18.000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"A capture notification informs the network that the amount has been settled and funds withdrawn from the operating account. The amount can be lower or greater than initial approved amount.
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c72b564-237a-445a-bd4a-d99400160b73"},{"name":"Authorization Request","id":"8d454d75-25d5-4205-98e6-382c24dc8b09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 51744,\n \"from_card_transaction_id\": null, \n \"entity_card_id\": 29,\n \"transaction_id\": null,\n \"merchant\": \"USA*FIVE STAR FOOD\",\n \"merchant_address\": null,\n \"merchant_city\": \"Paris\",\n \"merchant_state\": null,\n \"merchant_country\": \"FRA\",\n \"reference\": \"ad358d42-c490-4d33-be4a-09e82fea45f9\",\n \"authorization\": \"125985\",\n \"mcc\": 5512,\n \"type\": \"auth\",\n \"status\": {{Could be pending/completed/failed/declined}},\n \"currency\": \"USD\",\n \"local_currency\": null,\n \"local_amount\": null,\n \"exchange_rate\": null,\n \"channel\": null,\n \"pin_present\": 0,\n \"card_present\": 0,\n \"approved\": \"1.6000000000\",\n \"total\": \"1.600000000\",\n \"created_at\": \"2019-11-04 11:44:18.000000\",\n \"updated_at\": \"2019-11-04 11:44:18.000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"An authorization request notification will inform on updates against an approved authorization. In case it's a recently approved authorization, it will be on pending status with the approved amount set. Any updates to the status or approved amount will trigger an authorizaton notification.
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d454d75-25d5-4205-98e6-382c24dc8b09"},{"name":"Reversal Request","id":"752671c1-859b-45b6-b4bd-52b235840c6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 51744,\n \"from_card_transaction_id\": {{card transaction id of the linked card transaction}}, \n \"entity_card_id\": 29,\n \"transaction_id\": null,\n \"merchant\": \"USA*FIVE STAR FOOD\",\n \"merchant_address\": null,\n \"merchant_city\": \"Paris\",\n \"merchant_state\": null,\n \"merchant_country\": \"FRA\",\n \"reference\": \"ad358d42-c490-4d33-be4a-09e82fea45f9\",\n \"authorization\": \"125985\",\n \"mcc\": 5512,\n \"type\": \"unauth\",\n \"status\": \"completed\",\n \"currency\": \"USD\",\n \"local_currency\": null,\n \"local_amount\": null,\n \"exchange_rate\": null,\n \"channel\": null,\n \"pin_present\": 0,\n \"card_present\": 0,\n \"approved\": \"1.600000000\",\n \"total\": \"1.600000000\",\n \"created_at\": \"2019-11-04 11:44:18.000000\",\n \"updated_at\": \"2019-11-04 11:44:18.000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"Reversal requests come as type \"unauth\" and can be amounts lower or equal to the original card transaction.
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"752671c1-859b-45b6-b4bd-52b235840c6b"},{"name":"Refund Request","id":"c07ac7f3-aad4-469b-b398-756cda6612fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 51744,\n \"from_card_transaction_id\": {{card transaction id of the linked card transaction}}, \n \"entity_card_id\": 29,\n \"transaction_id\": null,\n \"merchant\": \"USA*FIVE STAR FOOD\",\n \"reference\": \"ad358d42-c490-4d33-be4a-09e82fea45f9\",\n \"authorization\": \"125985\",\n \"type\": \"refund\",\n \"status\": \"completed\",\n \"currency\": \"USD\",\n \"channel\": null,\n \"pin_present\": 0,\n \"approved\": \"1.600000000\",\n \"total\": \"1.600000000\",\n \"created_at\": \"2019-11-04 11:44:18.000000\",\n \"updated_at\": \"2019-11-04 11:44:18.000000\"\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"Refund requests come as type \"refund\" and can be amounts lower or equal to the original card transaction. The main difference of a refund from an unauth is the fact that it is not linked to a previous card transaction in the system. Although it really is due to a previous card authorization, it is only used to refund authorizations/sales card transaction types that were fully captured/settled.
\n","urlObject":{"host":["{{clientAuthorizationUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c07ac7f3-aad4-469b-b398-756cda6612fc"},{"name":"KYC Request","id":"871fbd8f-19c5-44fe-8bb1-78fa8fee6561","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 10736,\n \"parent_id\": 54815,\n \"parent_type\": \"App\\\\Entity\",\n \"decision_id\": 55,\n \"type\": \"entityIdentity\",\n \"score\": null,\n \"description\": \"Entity verification for username ****** from marqeta\",\n \"reference\": \"9481e89a-dc7f-4480-bec6-c4b8d0a74e40\",\n \"data\": \"{\\n \\\"created_time\\\" : \\\"2020-01-21T21:00:30Z\\\",\\n \\\"last_modified_time\\\" : \\\"2020-01-21T21:00:30Z\\\",\\n \\\"token\\\" : \\\"9481e89a-dc7f-4480-bec6-c4b8d0a74e40\\\",\\n \\\"user_token\\\" : \\\"08ee5ff7-1b04-4ba3-947e-34d01f30d27b\\\",\\n \\\"result\\\" : {\\n \\\"status\\\" : \\\"failure\\\",\\n \\\"codes\\\" : [ {\\n \\\"code\\\" : \\\"AddressIssue\\\"\\n } ]\\n },\\n \\\"manual_override\\\" : false,\\n \\\"questions\\\" : [ ],\\n \\\"reference_id\\\" : \\\"L-7HjxjLDYpuucvE6mL4aC\\\"\\n}\\n{\\n \\\"token\\\" : \\\"acccd55d-d1f6-466a-8636-b226ecd39b3d\\\",\\n \\\"user_token\\\" : \\\"08ee5ff7-1b04-4ba3-947e-34d01f30d27b\\\",\\n \\\"account_number\\\" : \\\"*****9999\\\",\\n \\\"routing_number\\\" : \\\"293748000\\\",\\n \\\"allow_immediate_credit\\\" : false\\n}\",\n \"attempts\": 1,\n \"status\": \"pending\",\n \"created_at\": \"2020-01-21 21:00:30\",\n \"updated_at\": \"2020-01-21 21:00:30\",\n \"deleted_at\": null,\n \"results\": [\n {\n \"id\": 39701,\n \"verification_id\": 10736,\n \"code\": null,\n \"field\": \"status\",\n \"message\": \"failure\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-01-21 21:00:30\",\n \"updated_at\": \"2020-01-21 21:00:30\"\n },\n {\n \"id\": 39702,\n \"verification_id\": 10736,\n \"code\": null,\n \"field\": \"code\",\n \"message\": \"AddressIssue\",\n \"data\": null,\n \"score\": null,\n \"created_at\": \"2020-01-21 21:00:30\",\n \"updated_at\": \"2020-01-21 21:00:30\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{clientAuthorizationUrl}}","description":"A KYC request will come with a copy of the verification record containing all different elements that caused the verification record to either be pending, verified, or failed. It is very important that the issuer handles this notification appropriately in a way that it can improve as much as possible the approval speed of a potential cardholder when the verification is on pending status. Check the Risk section to properly understand our KYC flow.
The disbursement request webhook will be triggered anytime the disbursement record has had a change or when it is created. The webhook will contain all relevant data of the disbursement and it will also contain the \"original_{{field}}\" fields which will contain the original value of the field that was changed (like the status when it gets updated to processed and the original_status before the change was processing. It is possible to configure based on the request of the client to only receive the webhook when certain fields change to certain values, for those cases the client must provide the conditions they want to receive the webhook in (which is limited to the field that changed and the expected value that fields need to be in, multiple fields in the disbursement record can be used).
With the intent to engage the issuer with updates in our system as much as possible, we offer a series of notification webhooks that are fired as soon as a change happens to a certain record in our system. The issuer should provide to their account manager a URL where it will be ready to handle all the notifications sent to their ecosystem. Although it is good practice to always provide a response to the notifications, the failure to do so does not impact the record in any way.
\n","_postman_id":"51c646ac-6751-4baa-866e-905cc63ce7d8"}],"id":"b0b4a51c-9727-42e9-a819-ceb40d50debd","description":"After records are created in our system, it can constantly change and update after API calls have been made. For that matter, we provide a series of incoming and outgoing webhooks for our users so that they are notified as soon as an update happens.
\nIncoming webhooks are notifications that indicate to the recipient that response from their side is required to fulfill a specified request. An example of an incoming webhook is the request to authorize a charge against a specific cardholder for purchase at a specific merchant.
\nOutgoing webhooks are notifications that are used only to notify the recipient, which means no response back is considered. These webhooks are important to let the user know exactly when the record changed, which engages them in providing changes to their respective ecosystems.
\nThe KYC simulator will get an entity based on the entity_id provided on the request and fire a verification notification with the status in the request (verified or pending). The notification will contain all fields that you would normally receive when in the live environment. That way it will be possible to properly test how your system is handling kyc related changes to your users and better engage it to your ecosystem in a way that it can be as most efficient as possible when handling kyc verifications.
Every time the authorization simulate API is used it will fire a fake authorization POST request to the registered URL on file. It will be in the same structure as if it was in the live environment, therefore the response needs to be according to the instructions on the Webhooks-> Authorization section. After approving the request, a notification will be fire right afterward containing the confirmed authorization recently approved. If you wish to test the entire cycle, send capture set to 1, which will not only approve the request but fire a capture notification of the same transaction right after confirming it, finalizing an authorization life cycle transaction. It is also possible to send the reversal flag set to 1, which will create a reversal (unauth) or refund (for sale type authorizations) right after the initial authorization was approved.
Authorization Simulation Data
\n","urlObject":{"path":["api","simulate","authorization"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8d3166c2-1dc5-4fa4-bb07-1921d255509a","name":"Authorization","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"entity_card_id\": 1,\n\t\"amount\": 10.00,\n\t\"merchant\": \"Starbucks\",\n\t\"capture\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/simulate/authorization"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"success\": true\n}"}],"_postman_id":"ceb230ab-e015-47c7-bcc8-5dec81e76112"}],"id":"552e3b91-e74b-4e07-9cdb-eb6a06f2f78c","description":"To help issuers test with their systems, we offer ways to simulate certain actions in way that will mimic the live environment as much as possible. With the simulate APIs, it will be possible to test and make sure that your system is appropriately handling important alerts that either require a response or contains important notification information from records that changed in our system.
\n","_postman_id":"552e3b91-e74b-4e07-9cdb-eb6a06f2f78c"}],"event":[{"listen":"prerequest","script":{"id":"67f93837-6660-4853-9df6-2d154a5d274f","type":"text/javascript","exec":["pm.sendRequest({"," url: pm.variables.get(\"url\") + '/api/v1/login',"," method: 'POST',"," header: {"," 'content-type': 'application/json'"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({"," username: pm.environment.get('username'),"," password: pm.environment.get('password')"," })"," }","}, function(err, res) {"," pm.environment.set(\"authorization\", res.json().data);","});","/*","const moment = require('moment');","const crypto = require('crypto-js');","let timestamp = ((new Date()).getTime() / 1000).toFixed(0);","let content = crypto.MD5(pm.request.body.raw).toString();","let apikey = pm.environment.get('apikey');","let secret = pm.environment.get('request_secret');","let signature = crypto.HmacSHA512(apikey + timestamp + content, secret).toString();","","pm.environment.set('timestamp', timestamp);","pm.environment.set('content', content);","pm.environment.set('signature', signature);","","","pm.request.headers.upsert({key: 'Accept', value: 'application/json' });","pm.request.headers.upsert({key: 'APIKEY', value: apikey });","pm.request.headers.upsert({key: 'TIMESTAMP', value: timestamp });","pm.request.headers.upsert({key: 'CONTENT', value: content });","pm.request.headers.upsert({key: 'SIGNATURE', value: signature });*/"]}},{"listen":"test","script":{"id":"83e16742-b519-488f-bf68-f897b06fc820","type":"text/javascript","exec":[""]}}]}