{"info":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","description":"

StartFragment

\n

Interfaces

\n

All data services are implemented in web and API interfaces. These guidelines cover API, and if you need access to web interfaces, kindly contact support@carmachain.com.

\n

EndFragment

\n

\n

Environments

\n

StartFragment

\n

Production and Testing environments are present under any available interface. The production environment requires valid credentials to be received after testing to get you in touch with actual data. The test environment mirrors user experience but real data access.

\n

EndFragment

\n

Production

\n

Base URL: https://app.carma.network/

\n

Test

\n

Base URL for link : https://testapp2.carma.network/

\n

Base URL for API-requests : http://138.201.239.80:8080/

\n

EndFragmen

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12241289","collectionId":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","publishedId":"UzBtkiVv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-06-28T06:34:52.000Z"},"item":[{"name":"BNPL Platform","item":[{"name":"You Merchant","item":[{"name":"Getting information about Loan Aplication Status","item":[{"name":"Loan Application List","id":"2ce6fe7a-215a-482c-ad9c-7665f8898a9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date_from\": \"2021-06-01T15:44:11Z\",\r\n \"date_to\":\"2024-06-01T15:44:11Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{URL}}/api/list_for_merchant","description":"

There are two options to restore historical information of your prospects:

\n
    \n

  1. Within the framework keeping open SSE session

    \n
    2. \n

  2. Mandatory status request with POST API method

    \n
    3. \n
\n

You should specify a certain period as set in the example if you use Option 2.

\n","urlObject":{"protocol":"http","path":["api","list_for_merchant"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8ebe02f5-3124-4e3d-80b4-eff62e71f1d5","name":"Prospects list for merchant","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date_from\": \"2021-06-01T15:44:11Z\",\r\n \"date_to\":\"2024-06-01T15:44:11Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/list_for_merchant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 16:00:05 GMT"},{"key":"Content-Length","value":"1965"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"query_id\": \"ewrere-37dss-6575-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"expiration_dt\": \"2022-10-07T05:23:02.741+03:00\",\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890121234\",\n \"electricity_meter_number\": \"52635462336\",\n \"email\": \"test@test.ua\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"is_approved\": false,\n \"creation_dt\": \"2022-10-06T17:23:02.741+03:00\",\n \"legal_name\": \"Test_merchant\",\n \"account_number\": \"11111111111111111111111111111\",\n \"account_name\": \"Test account\",\n \"bank_name\": \"Test Bank\"\n },\n {\n \"query_id\": \"87f9779c-3785-11ed-a261-0242ac120049\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"expiration_dt\": \"2022-10-07T04:19:05.446+03:00\",\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890123456\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"is_approved\": false,\n \"creation_dt\": \"2022-10-06T16:19:05.446+03:00\",\n \"legal_name\": \"Test_merchant\",\n \"account_number\": \"11111111111111111111111111111\",\n \"account_name\": \"Test account\",\n \"bank_name\": \"Test Bank\"\n }\n]"}],"_postman_id":"2ce6fe7a-215a-482c-ad9c-7665f8898a9e"},{"name":"Specific Prospect Look-Up","id":"ee21232a-bfd6-4807-8845-002e8ec131de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\":\"87f9779c-3785-w44ed-a261-0242ac120004\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{URL}}/api/get_prospect_information","description":"

It is another option to get a status update on a prospect loan application. Ping it with Query ID to receive the recent update.

\n","urlObject":{"protocol":"http","path":["api","get_prospect_information"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d9129981-6756-4c79-bb9a-f56ef4eefea9","name":"Get Prospect Information","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\":\"ewrere-37dss-6575-a261-0242ac120004\"\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/get_prospect_information"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 14:23:44 GMT"},{"key":"Content-Length","value":"1013"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"query_id\": \"ewrere-37dss-6575-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"expiration_dt\": \"2022-10-07T05:23:02.741+03:00\",\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890121234\",\n \"electricity_meter_number\": \"52635462336\",\n \"email\": \"test@test.ua\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"is_approved\": false,\n \"creation_dt\": \"2022-10-06T17:23:02.741+03:00\",\n \"legal_name\": \"Test_merchant\",\n \"account_number\": \"11111111111111111111111111111\",\n \"account_name\": \"Test account\",\n \"bank_name\": \"Test Bank\"\n}"}],"_postman_id":"ee21232a-bfd6-4807-8845-002e8ec131de"}],"id":"8e8f4050-81f6-43ed-a9db-01c023fab96d","description":"

As part of the implementation of the functionality for obtaining the status of processing a loan application, we offer the following options:

\n
    \n
  1. obtaining a status within the framework of an open SSE session
    2. \n
  2. status request after a certain time by credit application ID
    3. \n
  3. view the status on the dashboard of the CARMACHAIN platform
    4. \n
\n

** Use SSE Ongoing SSE Session for Status Update **

\n

Kindly use these instructions to get noticed on prospect status update (Acquired/Expired) to get.

\n

More about SSE: https://learn.javascript.ru/server-sent-events
Authorization:
The window.EventSource doesn't seem to support passing additional headers yet. Good news is there are some other popular implementations of EventSource that support additional headers. Some of them are as follows:

\n

* eventsource
* event-source-polyfill

\n
const eventSource = new EventSource(resoureUrl, {\n            headers: {\n                'Authorization': 'Bearer ' + authorizationToken\n            }\n        });\neventSource.onmessage = result => {\n    const data = JSON.parse(result.data);\n    console.log('Data: ', data);\n};\neventSource.onerror = err => {\n    console.log('EventSource error: ', err);\n};\n\n
\n
Our handlers:
\n

* for LoanCompany: {{URL}}/api/report_to_loan_company
* for Merchant: {{URL}}//api/report_to_merchant

\n
Events:
\n

* created - receive information about new prosrects

\n

* approved - recive updated status of prospect

\n

Postman does not support SSE. For tests from the console, you can use Curl

\n

Example:

\n
curl -N --http2 -H \"Accept:text/event-stream\" -H \"Authorization: Bearer {{token}}\" {{URL}}/api/report_to_loan_company \n\n
","_postman_id":"8e8f4050-81f6-43ed-a9db-01c023fab96d","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","type":"collection"}}},{"name":"Link to creating new prospect ( Loan Application Form )","id":"0de49e97-fdc3-4545-98f0-9a7b88f420b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"LINK","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{lURL}}/loan/?loan_id=FDNFUER433rndjcn &amount=10000&description=tikets&login=user&password=password","description":"

Please send the following request body tied up to your shop BNPL button for starting the loan application process:

\n

* loan_id - the purchase ID you can use to track further loan process

\n

* amount - the purchase/loan amount

\n

* description - purchase description

\n

* login - account of your organization with CARMACHAIN

\n

* password - your account password

\n

Please add AES-192-CBC encryption with the key \"carmachain\" to complete your request. Find the sample below:

\n
$data = [\n            'loan_id' => 1,\n            'amount' => 10000,\n            'description' => 'tikets',\n            'login' => 'user name',\n            'password' => 'pass'\n        ];\nopenssl_encrypt(json_encode($data), \"AES-192-CBC\", 'carmachain')\n\n
\n

You receive the unique link for a customer’s loan application to fill in (Stage 2).

\n","urlObject":{"path":["loan",""],"host":["{{lURL}}"],"query":[{"key":"loan_id","value":"FDNFUER433rndjcn "},{"key":"amount","value":"10000"},{"key":"description","value":"tikets"},{"key":"login","value":"user"},{"key":"password","value":"password"}],"variable":[]}},"response":[{"id":"55949491-2c2e-4591-8342-0671cc8678c2","name":"Create Loan Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\": \"87f9779c-3785-w44ed-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"application_valid_for\": 12,\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"email\":\"test@test.ua\",\n \"electricity_meter_number\":\"52635462336\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890121234\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\"\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/create_loan_request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 09:45:30 GMT"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request Created\"\n}"}],"_postman_id":"0de49e97-fdc3-4545-98f0-9a7b88f420b3"},{"name":"Send Loan Application Data with API","id":"fd0d4afd-5497-487a-b057-55b997ce02a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\": \"87f9779c-3785-11ed-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"application_valid_for\": 12,\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"123456789\",\n \"national_identification_number\": \"1234567890\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"email\":\"test@test.ua\",\n \"electricity_meter_number\":\"52635462336\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"123456789012\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\"\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/create_loan_request","description":"

In case you would like to implement filling in the loan applications on your side instead of using CARMACHAIN web-page (which is highly recommended), please use instructions below to wired full list of data required by the pool of lenders.

\n

Please note the list of data points can be changed anytime.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","create_loan_request"],"host":["138","201","239","80"],"query":[],"variable":[]}},"response":[{"id":"fce0abe5-1a43-4b30-a8b5-c527ca08c7ec","name":"Create Loan Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\": \"87f9779c-3785-w44ed-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"application_valid_for\": 12,\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"email\":\"test@test.ua\",\n \"electricity_meter_number\":\"52635462336\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890121234\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\"\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/create_loan_request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 09:45:30 GMT"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Request Created\"\n}"}],"_postman_id":"fd0d4afd-5497-487a-b057-55b997ce02a4"}],"id":"1d820b97-ba03-4966-8b57-166463b577cb","description":"

StartFragment

\n

BNPL process concludes four stages:

\n
    \n
  1. You collect purchase information and get unique purchase link
    2. \n
  2. You forward purchaser by the unique purchase link to fill in a loan application
    3. \n
  3. The loan application channels to a pool of lenders
    4. \n
  4. You stand by to receive a loan resolution from the pool of lenders
    5. \n
\n

EndFragment

\n","_postman_id":"1d820b97-ba03-4966-8b57-166463b577cb","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","type":"collection"}}},{"name":"You Credit Company","item":[{"name":"Prospects Sourcing","id":"42b5b174-097b-457f-9bd2-8c995c63b953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date_from\": \"2023-06-01T15:44:11Z\",\r\n \"date_to\":\"2023-06-01T15:44:11Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{lURL}}/api/list_for_loan_company","description":"

You can get bulk information on the currently available and your previously acquired prospects:

\n
    \n

  1. Within the framework keeping open SSE session

    \n
    2. \n

  2. Mandatory status request

    \n
    3. \n
\n

You should specify a certain period as set in the example if you use Option 2. Please note you will have visibility only for prospects:
- that were approved by your organizations
- currently available for acquisitions.

\n

Please note using you will have visibility only for prospects:
- that were approved by your organizations
- currently available for acquisitions

\n","urlObject":{"path":["api","list_for_loan_company"],"host":["{{lURL}}"],"query":[],"variable":[]}},"response":[{"id":"87f74051-2e9a-48e6-8927-92f70268bd0d","name":"Prospects list for loan company","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date_from\": \"2021-06-01T15:44:11Z\",\r\n \"date_to\":\"2024-06-01T15:44:11Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/list_for_merchant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 16:00:05 GMT"},{"key":"Content-Length","value":"1965"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"query_id\": \"ewrere-37dss-6575-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"expiration_dt\": \"2022-10-07T05:23:02.741+03:00\",\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890121234\",\n \"electricity_meter_number\": \"52635462336\",\n \"email\": \"test@test.ua\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"is_approved\": false,\n \"creation_dt\": \"2022-10-06T17:23:02.741+03:00\",\n \"legal_name\": \"Test_merchant\",\n \"account_number\": \"11111111111111111111111111111\",\n \"account_name\": \"Test account\",\n \"bank_name\": \"Test Bank\"\n },\n {\n \"query_id\": \"87f9779c-3785-11ed-a261-0242ac120049\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"expiration_dt\": \"2022-10-07T04:19:05.446+03:00\",\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890123456\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"is_approved\": false,\n \"creation_dt\": \"2022-10-06T16:19:05.446+03:00\",\n \"legal_name\": \"Test_merchant\",\n \"account_number\": \"11111111111111111111111111111\",\n \"account_name\": \"Test account\",\n \"bank_name\": \"Test Bank\"\n }\n]"}],"_postman_id":"42b5b174-097b-457f-9bd2-8c995c63b953"},{"name":"Specific Prospect Look-Up","id":"59d92a37-f985-42e2-af2a-1939107167ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\":\"87f9779c-3785-w44ed-a261-0242ac120004\"\n}","options":{"raw":{"language":"json"}}},"url":"http://{{URL}}/api/get_prospect_information","description":"

Use prospect ID to recover application data.

\n

Please note using you will have visibility only for prospects:
- that were approved by your organizations
- currently available for acquisitions

\n","urlObject":{"protocol":"http","path":["api","get_prospect_information"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"61b7f45d-89d1-4145-8800-e0d5c5d602c8","name":"Get Prospect Information","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\":\"ewrere-37dss-6575-a261-0242ac120004\"\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/get_prospect_information"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 14:23:44 GMT"},{"key":"Content-Length","value":"1013"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"query_id\": \"ewrere-37dss-6575-a261-0242ac120004\",\n \"loan_amount\": 5000.24,\n \"purchase_id\": \"20\",\n \"purchase_description\": \"telephone\",\n \"currency\": \"NGN\",\n \"repayment_period\": \"month\",\n \"number_of_periods\": 4,\n \"expiration_dt\": \"2022-10-07T05:23:02.741+03:00\",\n \"full_name\": \"Jhon Doe\",\n \"bank_verification_number\": \"12345678\",\n \"national_identification_number\": \"12345678\",\n \"phone_number\": \"1123456789\",\n \"referee_phone_number\": \"1123456789\",\n \"home_address\": \"Home Address\",\n \"card_number\": \"1234567890121234\",\n \"electricity_meter_number\": \"52635462336\",\n \"email\": \"test@test.ua\",\n \"photo_person_id\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_selfie\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"photo_bank_statement\": \"data:image/jpeg;base64,9j/4AAQSkZJRgABAQIAOAA4AAD/2wBDACAWGBwYFCAcGh...\",\n \"is_approved\": false,\n \"creation_dt\": \"2022-10-06T17:23:02.741+03:00\",\n \"legal_name\": \"Test_merchant\",\n \"account_number\": \"11111111111111111111111111111\",\n \"account_name\": \"Test account\",\n \"bank_name\": \"Test Bank\"\n}"}],"_postman_id":"59d92a37-f985-42e2-af2a-1939107167ca"},{"name":"To Approve Prospect","id":"b487893c-cc82-4aff-b9a9-ec3b02bfa714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\": \"87f9779c-3785-11ed-a261-0242ac120004\"\n}","options":{"raw":{"language":"json"}}},"url":"{{lURL}}/api/approve_prospect","description":"

Please note you should receive confirmation of the prospect acquisition before making any further moves. This is the way to avoid ambiguity in understanding who has acquired the prospect considering real-time distribution.

\n","urlObject":{"path":["api","approve_prospect"],"host":["{{lURL}}"],"query":[],"variable":[]}},"response":[{"id":"ac545104-fe58-4534-a841-170429dd5749","name":"ApproveProspect","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"query_id\":\"ewrere-37dss-6575-a261-0242ac120004\"\n}","options":{"raw":{"language":"json"}}},"url":"http://138.201.239.80:8080/api/approve_prospect"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 06 Oct 2022 16:15:58 GMT"},{"key":"Content-Length","value":"32"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"prospect approved\"\n}"}],"_postman_id":"b487893c-cc82-4aff-b9a9-ec3b02bfa714"}],"id":"c9ef6969-abbe-49b0-95ca-a7c94bbb0ba5","description":"

As part of the implementation of the functionality for obtaining the status of processing a loan application, we offer the following options:

\n
    \n
  1. obtaining a status within the framework of an open SSE session
    2. \n
  2. status request after a certain time by credit application ID
    3. \n
  3. view the status on the dashboard of the CARMACHAIN platform
    4. \n
\n

** Real-time Tracking for New Prospects and Update Status **

\n

Please use this service to get in touch with new prospects and their status in real time.

\n

More about SSE: https://learn.javascript.ru/server-sent-events
Authorization:
The window.EventSource doesn't seem to support passing additional headers yet. Good news is there are some other popular implementations of EventSource that support additional headers. Some of them are as follows:

\n

* eventsource
* event-source-polyfill

\n
const eventSource = new EventSource(resoureUrl, {\n            headers: {\n                'Authorization': 'Bearer ' + authorizationToken\n            }\n        });\neventSource.onmessage = result => {\n    const data = JSON.parse(result.data);\n    console.log('Data: ', data);\n};\neventSource.onerror = err => {\n    console.log('EventSource error: ', err);\n};\n\n
\n
Our handlers:
\n

* for LoanCompany: {{URL}}/api/report_to_loan_company
* for Merchant: {{URL}}//api/report_to_merchant

\n
Events:
\n

* created - receive information about new prosrects

\n

* approved - recive updated status of prospect

\n

Postman does not support SSE. For tests from the console, you can use Curl

\n

Example:

\n
curl -N --http2 -H \"Accept:text/event-stream\" -H \"Authorization: Bearer {{token}}\" {{URL}}/api/report_to_loan_company \n\n
","_postman_id":"c9ef6969-abbe-49b0-95ca-a7c94bbb0ba5","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","type":"collection"}}}],"id":"1321ddf2-87d8-4bfa-87f8-7b3c7fd93b44","description":"

StartFragment

\n

Please use this section to get on board with BNPL services, both for merchants and lenders, with API.

\n

EndFragment

\n","_postman_id":"1321ddf2-87d8-4bfa-87f8-7b3c7fd93b44","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","type":"collection"}}},{"name":"CARMACHAIN Search Services","item":[{"name":"Search categories","id":"006ebca9-d14c-45e1-aaf0-e289d8d223a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/api/search_categories","description":"

We have a number of datapoints that we combine into categories. You can get a list of all relevant categories using the following api

\n","urlObject":{"protocol":"http","port":"8080","path":["api","search_categories"],"host":["app","carma","network"],"query":[],"variable":[]}},"response":[{"id":"72d7e9ff-0022-49e1-a825-6b8f549c8992","name":"Search categories","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://testapp2.carma.network:8080/api/search_categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 06 Jul 2022 08:18:20 GMT"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n \"All Categories\",\n \"Credit Data\",\n \"Transaction Data\",\n \"Utility Data\"\n ]\n}"}],"_postman_id":"006ebca9-d14c-45e1-aaf0-e289d8d223a0"},{"name":"Create request. Get response","id":"477d8357-361f-4d6e-a825-ae89c75b2f6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": [ \"All categories\"],\n \"key_value\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"07037826883\"\n },\n \"timeout\": 20\n}","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/api/request","description":"

Using this api-call, you can create an information search request within one session and immediately get an aggregated report on the information that was found.

\n

Since some data sources can give information for a long time using the parameter “timeout”, you specify the maximum time in seconds how long you are ready to wait for a response. The aggregated report will be provided either when all data sources respond or when the timeout is reached.

\n

REQUEST BODY SCHEME: application/json

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersTypeDescribe
categoriesstringIndicator of the type of information that we are looking for in this request. A list of all available categories can be obtained using the API-call ../api/search_categories .
key_valueArray of objects
The name and value of the parameter to search for
keystringThe name of the parameter to search for.
Now the search is valid for the following keys:
- \"ID/NRC : BVN\"
- \"Phone Numbers : Personal\"
- \"Utility : Number\"
valuestringvalue of the parameter to search for
timeoutintThe time in seconds that the user is willing to wait for a response.
\n
","urlObject":{"protocol":"http","port":"8080","path":["api","request"],"host":["app","carma","network"],"query":[],"variable":[]}},"response":[{"id":"d41f219a-48b5-4ec8-969c-e504de497ea1","name":"Create request. Get response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": [ \"Address\", \"Consumer Profile\"],\n \"key_value\": {\n \"key\": \"Phone Numbers : Personal\",\n \"value\": \"07037826883\"\n },\n \"timeout\": 90\n}","options":{"raw":{"language":"json"}}},"url":"http://testapp2.carma.network:8080/api/request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 28 Jun 2022 06:46:34 GMT"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"request\": {\n \"request\": {\n \"Categories\": [\n \"Address\",\n \"Consumer Profile\"\n ],\n \"KeyValue\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"07037826883\"\n },\n \"ExpiringUnixSec\": 1656398871\n },\n \"id\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"timeout\": 90,\n \"status\": \"done\",\n \"creation_time\": 1656398781,\n \"closing_time\": 1656398794\n },\n \"responses\": [\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Overall Payments Count\",\n \"Value\": \"4\"\n },\n {\n \"Key\": \"Remittance : Overall Payments Amount\",\n \"Value\": \"19900\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Count\",\n \"Value\": \"4\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Volume\",\n \"Value\": \"19900\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 234,\n \"TimestampUnixSec\": 1656398781,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n },\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"6950\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"SUNDRY MARKETS LIMITED BY LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-03-09 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"4600\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"GRAND SHOP RI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-03-04 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"1400\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"RDIVINE SUPERSTORES LA LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-02-27 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"6950\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"SUNDRY MARKETS LIMITED BY LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-03-09 00:00:00.0\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 331,\n \"TimestampUnixSec\": 1656398781,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n },\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"Payload\": {\n \"Name\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Name : Full Name\"\n }\n ]\n }\n ]\n },\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Utility : Subscription Type\",\n \"Value\": \"PREPAID_METER\"\n },\n {\n \"Key\": \"Utility : Number\",\n \"Value\": \"04180816052\"\n },\n {\n \"Key\": \"Primary Location : Address\",\n \"Value\": \"10 ADOKIYE AVE OFF TIMBO ABULOMA AMADI AMA PH N/A\"\n },\n {\n \"Key\": \"Utility : Utility Asset Owner\",\n \"Value\": \"MR AMBROSE FYNEFACE\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Utility : Subscription Type\",\n \"Value\": \"PREPAID_METER\"\n },\n {\n \"Key\": \"Utility : Number\",\n \"Value\": \"68100009338\"\n },\n {\n \"Key\": \"Primary Location : Address\",\n \"Value\": \"NO.5 EMMANUEL AVENUE OFF N/A\"\n },\n {\n \"Key\": \"Utility : Utility Asset Owner\",\n \"Value\": \"MRS HARRISON GEORGE(ALLISON I.\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 13486,\n \"TimestampUnixSec\": 1656398794,\n \"Author\": \"Utility company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\",\n \"Name\"\n ]\n }\n ]\n}"},{"id":"951085a3-7a16-4dbb-abea-2eb4b2fc42bd","name":"Create request. Get response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": [ \"Transaction Data\"],\n \"key_value\": { \n \"key\": \"Phone Numbers : Personal\",\n \"value\": \"2348037089841\"\n },\n \"timeout\": 20\n}","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/api/request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 07 Nov 2022 07:56:01 GMT"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"request\": {\n \"request\": {\n \"Categories\": [\n \"Transaction Data\"\n ],\n \"KeyValue\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"2348037089841\"\n },\n \"ExpiringUnixSec\": 1667807777\n },\n \"id\": \"6b035de4-775e-4b9c-ab3f-b1365494e320\",\n \"timeout\": 20,\n \"status\": \"done\",\n \"creation_time\": 1667807757,\n \"closing_time\": 1667807761\n },\n \"responses\": [\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"6b035de4-775e-4b9c-ab3f-b1365494e320\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Overall Payments Count\",\n \"Value\": \"15\"\n },\n {\n \"Key\": \"Remittance : Overall Payments Amount\",\n \"Value\": \"9858000\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Count\",\n \"Value\": \"2\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Volume\",\n \"Value\": \"1000000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Count\",\n \"Value\": \"13\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Volume\",\n \"Value\": \"8858000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 664,\n \"TimestampUnixSec\": 1667807758,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n },\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"6b035de4-775e-4b9c-ab3f-b1365494e320\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"170000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"FOJEH INTEGRATED SERVICRI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"500000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"ATM\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"GTBank EBranch PH Aba oad NG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-03 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"170000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"FOJEH INTEGRATED SERVICRI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"700000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"TWIN SISTERS HOTEL AND RI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"700000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"TWIN SISTERS HOTEL AND RI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"500000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"ATM\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"GTBank EBranch PH Aba road RVNG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-03 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"818000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"SUNDRY MARKET LIMITED RI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-10-08 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"2030000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"PALMPAY LIMITED LA LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-10-11 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"610000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"DEMIMI CATERING SERVICELA LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-07-15 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"140000\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"PAYCOM NIGERIA LIMITED LA LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"FIRST BANK\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-07-04 00:00:00.0\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 720,\n \"TimestampUnixSec\": 1667807758,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n },\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"6b035de4-775e-4b9c-ab3f-b1365494e320\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"170000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"500000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-03 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"170000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"700000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"700000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-25 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"500000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"CASH WITHDRAWAL\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-09-03 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"818000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-10-08 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"2030000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-10-11 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"610000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-07-15 00:00:00 +0000 UTC\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"140000\"\n },\n {\n \"Key\": \"Remittance : Transfer Currency\",\n \"Value\": \"NGN\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"PURCHASE\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"DEBIT\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"interswitch\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-07-04 00:00:00 +0000 UTC\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 4187,\n \"TimestampUnixSec\": 1667807761,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n }\n ]\n}"}],"_postman_id":"477d8357-361f-4d6e-a825-ae89c75b2f6b"},{"name":"Create request. No wait","id":"7756d269-6f97-43ca-8e97-f1737d2bbeca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": [ \"All categoryes\"],\n \"key_value\":{\n \"key\": \"Phone Numbers : Personal\",\n \"value\": \"07037826883\"\n },\n \"timeout\": 20\n}","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/api/createrequest","description":"

Using this api-call, you can create a request to search for information within one session and, as a result, get the request ID. Then, using another api-call, get an aggregated report on the information that was found at a convenient time for you.

\n

Since some data sources can give information for a long time using the parameter, you specify the maximum time in seconds how long you are ready to wait for a response. The aggregated report will be provided either when all data sources respond or when the timeout is reached.

\n

StartFragment

\n

REQUEST BODY SCHEME: application/json

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersTypeDescribe
categoriesstringIndicator of the type of information that we are looking for in this request. A list of all available categories can be obtained using the API-call ../api/search_categories .
key_valueArray of objects
The name and value of the parameter to search for
keystringThe name of the parameter to search for.
Now the search is valid for the following keys:
- \"ID/NRC : BVN\"
- \"Phone Numbers : Personal\"
- \"Utility : Number\"
valuestringvalue of the parameter to search for
timeoutintThe time in seconds that the user is willing to wait for a response.
\n

EndFragment

\n","urlObject":{"protocol":"http","port":"8080","path":["api","createrequest"],"host":["app","carma","network"],"query":[],"variable":[]}},"response":[{"id":"b9e83b85-9b04-4d04-8a0e-8c6814f9e400","name":"Create request. No wait","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": [ \"Address\", \"Consumer Profile\"],\n \"key_value\":{\n \"key\": \"Phone Numbers : Personal\",\n \"value\": \"0505872555\"\n },\n \"timeout\": 120\n}","options":{"raw":{"language":"json"}}},"url":"http://testapp2.carma.network:8080/api/createrequest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 28 Jun 2022 06:45:34 GMT"},{"key":"Content-Length","value":"278"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"request\": {\n \"Categories\": [\n \"Address\",\n \"Consumer Profile\"\n ],\n \"KeyValue\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"0505872555\"\n },\n \"ExpiringUnixSec\": 1656398854\n },\n \"id\": \"c2b522f8-ee6b-4e0c-a58c-df1e374d501e\",\n \"timeout\": 120,\n \"status\": \"created\",\n \"creation_time\": 1656398734,\n \"closing_time\": null\n}"}],"_postman_id":"7756d269-6f97-43ca-8e97-f1737d2bbeca"},{"name":"Get response","id":"77140d75-fc96-4590-96d9-88c6389a51e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_id\": \"1c304f85-1669-4f52-ac87-a4acb00981b8\"\n}","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/api/respond","description":"

An important point for receiving a response is that it takes time to process a request for all sources, sometimes it can even take several minutes. Therefore, in the response, we have a field “status”, which is responsible for whether the request has been processed on all sources.

\n

Therefore, we recommend calling this api with a time lag of up to 0.5 to 1 second.

\n","urlObject":{"protocol":"http","port":"8080","path":["api","respond"],"host":["app","carma","network"],"query":[],"variable":[]}},"response":[{"id":"bfc269f1-d795-4669-b0e9-830b7c2d359b","name":"Get response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request_id\": \"927394bb-85cc-4f68-b380-372b16044fd7\"\n}","options":{"raw":{"language":"json"}}},"url":"http://testapp2.carma.network:8080/api/respond"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 28 Jun 2022 06:47:16 GMT"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"request\": {\n \"request\": {\n \"Categories\": [\n \"Address\",\n \"Consumer Profile\"\n ],\n \"KeyValue\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"07037826883\"\n },\n \"ExpiringUnixSec\": 1656398871\n },\n \"id\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"timeout\": 90,\n \"status\": \"done\",\n \"creation_time\": 1656398781,\n \"closing_time\": 1656398794\n },\n \"responses\": [\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Overall Payments Count\",\n \"Value\": \"4\"\n },\n {\n \"Key\": \"Remittance : Overall Payments Amount\",\n \"Value\": \"19900\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Count\",\n \"Value\": \"4\"\n },\n {\n \"Key\": \"Remittance : Specific Transaction Volume\",\n \"Value\": \"19900\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 234,\n \"TimestampUnixSec\": 1656398781,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n },\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"Payload\": {\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"6950\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"SUNDRY MARKETS LIMITED BY LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-03-09 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"4600\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"GRAND SHOP RI LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-03-04 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"1400\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"RDIVINE SUPERSTORES LA LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-02-27 00:00:00.0\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Remittance : Specific Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transfer Amount\",\n \"Value\": \"6950\"\n },\n {\n \"Key\": \"Remittance : Transaction Type\",\n \"Value\": \"POS Purchase\"\n },\n {\n \"Key\": \"Remittance : Transaction Channel\",\n \"Value\": \"POS\"\n },\n {\n \"Key\": \"Remittance : Merchant\",\n \"Value\": \"SUNDRY MARKETS LIMITED BY LANG\"\n },\n {\n \"Key\": \"Remittance : Card Issuer\",\n \"Value\": \"MASTERCARD\"\n },\n {\n \"Key\": \"Remittance : Acquirer Bank\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"Remittance : Issuer Bank\",\n \"Value\": \"Zenith Bank Plc\"\n },\n {\n \"Key\": \"Remittance : Transfer Timestamp\",\n \"Value\": \"2022-03-09 00:00:00.0\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 331,\n \"TimestampUnixSec\": 1656398781,\n \"Author\": \"Payment company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Transaction Data\"\n ]\n },\n {\n \"peer_response_with_source\": {\n \"RequestID\": \"927394bb-85cc-4f68-b380-372b16044fd7\",\n \"Payload\": {\n \"Name\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Name : Full Name\"\n }\n ]\n }\n ]\n },\n \"Transaction Data\": {\n \"Answers\": [\n {\n \"Answer\": [\n {\n \"Key\": \"Utility : Subscription Type\",\n \"Value\": \"PREPAID_METER\"\n },\n {\n \"Key\": \"Utility : Number\",\n \"Value\": \"04180816052\"\n },\n {\n \"Key\": \"Primary Location : Address\",\n \"Value\": \"10 ADOKIYE AVE OFF TIMBO ABULOMA AMADI AMA PH N/A\"\n },\n {\n \"Key\": \"Utility : Utility Asset Owner\",\n \"Value\": \"MR AMBROSE FYNEFACE\"\n }\n ]\n },\n {\n \"Answer\": [\n {\n \"Key\": \"Utility : Subscription Type\",\n \"Value\": \"PREPAID_METER\"\n },\n {\n \"Key\": \"Utility : Number\",\n \"Value\": \"68100009338\"\n },\n {\n \"Key\": \"Primary Location : Address\",\n \"Value\": \"NO.5 EMMANUEL AVENUE OFF N/A\"\n },\n {\n \"Key\": \"Utility : Utility Asset Owner\",\n \"Value\": \"MRS HARRISON GEORGE(ALLISON I.\"\n }\n ]\n }\n ]\n }\n },\n \"ProcessingTimeMs\": 13486,\n \"TimestampUnixSec\": 1656398794,\n \"Author\": \"Utility company\",\n \"IsValid\": true\n },\n \"categories\": [\n \"Name\",\n \"Transaction Data\"\n ]\n }\n ]\n}"}],"_postman_id":"77140d75-fc96-4590-96d9-88c6389a51e5"},{"name":"Requests list with respond","id":"2451d233-aae8-45a2-bbf2-d19fb40c0554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date_from\": \"2022-06-15\",\r\n \"date_to\": \"2022-06-22\", \r\n \"page\":1,\r\n \"page_size\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/api/search_requests_with_respond_list","description":"

Export list request what you created during period

\n","urlObject":{"protocol":"http","port":"8080","path":["api","search_requests_with_respond_list"],"host":["app","carma","network"],"query":[],"variable":[]}},"response":[{"id":"766471e0-3732-4fd5-8b31-e5bb17d68298","name":"Requests list with respond","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date_from\": \"2022-06-15\",\r\n \"date_to\": \"2022-06-22\", \r\n \"page\":1,\r\n \"page_size\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"http://testapp2.carma.network:8080/api/search_requests_with_respond_list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 19 Aug 2022 09:40:46 GMT"},{"key":"Content-Length","value":"653"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"Responses\": [\n {\n \"request\": {\n \"request\": {\n \"Categories\": [\n \"All categoryes\"\n ],\n \"KeyValue\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"07037826883\"\n },\n \"ExpiringUnixSec\": 1655843570\n },\n \"id\": \"28d5632b-6c2e-4717-ad86-2e55b22e87e0\",\n \"timeout\": 60,\n \"status\": \"done\",\n \"creation_time\": 1655843510,\n \"closing_time\": 1655843570\n },\n \"responses\": null\n },\n {\n \"request\": {\n \"request\": {\n \"Categories\": [\n \"All categoryes\"\n ],\n \"KeyValue\": {\n \"Key\": \"Phone Numbers : Personal\",\n \"Value\": \"07037826883\"\n },\n \"ExpiringUnixSec\": 1655843243\n },\n \"id\": \"0475d8f0-516f-4f51-bbef-491353dfdc0a\",\n \"timeout\": 60,\n \"status\": \"done\",\n \"creation_time\": 1655843183,\n \"closing_time\": 1655843243\n },\n \"responses\": null\n }\n ],\n \"CountPage\": 21822,\n \"CountResponses\": 43643\n}"}],"_postman_id":"2451d233-aae8-45a2-bbf2-d19fb40c0554"}],"id":"2c60e0f5-5b93-4c49-a2ef-04ded274ce11","description":"
This service is designed to search and validate user data.
\n

To create requests and receive responses to them, we have two ways:

\n

- sending a call to request information and receiving a response in the same session.

\n

- sending a call to create a request, after sending a request to receive a response for a given request ID.

\n

These options give the user more options to create integration with the system in a simpler and more appropriate way.

\n","_postman_id":"2c60e0f5-5b93-4c49-a2ef-04ded274ce11","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","type":"collection"}}},{"name":"Get token","id":"fce56ae4-a29b-44ad-bdf6-88e7dd99b375","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \n \"user\": user name\n \"password\": password\n} ","options":{"raw":{"language":"json"}}},"url":"http://app.carma.network:8080/auth/getToken","description":"

All requests to the API-call must have a baseUrl.

\n

The baseUrl depends on the it infrastructure where the client application module is deployed

\n

APIKeyHeader

\n

This is the most secure authorization type and the one with the most flexibility.

\n

API keys can generate by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can revoke at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

\n

You can manage your API keys programmatically with API-request.

\n

For getting API-key you need to send next request

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","id":"b2b99c6c-2ab6-44d7-9e0d-34c2a78e9770","name":"CARMACHAIN API DATA SUITE 2.0","type":"collection"}},"urlObject":{"protocol":"http","port":"8080","path":["auth","getToken"],"host":["app","carma","network"],"query":[],"variable":[]}},"response":[{"id":"5af79c46-aaba-49bf-bdef-359f22736005","name":"Get token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \n \"user\": @user_login,\n \"password\": @password\n} ","options":{"raw":{"language":"json"}}},"url":"http://testapp2.carma.network:8080/auth/getToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 28 Jun 2022 06:44:21 GMT"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJQZWVySUQiOiJOR1A1IiwiVXNlcklEIjoxLCJleHAiOjE2NTY0ODUwNjF9.Kk6ryTkRgvDxWpkxCNw9Ojzahw_CxV8CmESEf6UMfEU\"\n}"}],"_postman_id":"fce56ae4-a29b-44ad-bdf6-88e7dd99b375"}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"a629761b-fb02-42f4-87a6-2992927fb3d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab745247-6ab8-421f-86ad-eeae32073066","type":"text/javascript","exec":[""]}}],"variable":[{"key":"user_name","value":"user","type":"string"},{"key":"password","value":"password","type":"string"}]}