{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"28a74a0f-2a52-47f9-80ef-5c13f6990dd3","name":"Subex IDC APIs v1.80.0","description":"# **IDcentral (IDC)**\n\nIDcentral's identity analytics solution assists companies in delivering a seamless and secure customer experience while preventing fraud. A key challenge faced by companies today is balancing customer satisfaction with cybersecurity. Our solution utilizes multiple data sources to verify true identities without unnecessary data collection, simplifying the digital onboarding process. Moreover, it enhances sales conversions by leveraging over 200 data attributes for decision-making. For seamless integration with third-party applications, IDcentral offers powerful REST APIs for instant verification. These user-friendly endpoints empower developers to create custom onboarding applications for various scenarios. Additionally, IDcentral seamlessly integrates with existing applications and workflows, safeguarding against identity fraud, forgery, and spamming.\n\n## **Modes Of Accessing the Services**\n\n- Restful API - Our API is optimized for automation, offering scalability and high availability. It is particularly well-suited for integrating with app and web app workflows, making it an ideal solution for businesses looking to automate processes.\n    \n- Client Portal - Our Client Portal is a user interface which provides a simple and intuitive platform for real-time data verification. It is particularly well-suited for manual and small-scale checks, enabling quick and easy verification of data.\n    \n\nIDcentral's services are available to registered legal entities worldwide, ensuring global accessibility for businesses seeking our solutions.\n\n## Registration Quickstart\n\nTo request an account with IDcentral, please visit our [Contact Us](https://www.idcentral.io/contact-us/) page and provide your name, company name, official email ID, and contact number. After discussing your requirements, we will share the link to our portal. The sign-up process requires verification of your business email, and a one-time password will be sent to the email you provided for this purpose.\n\nOnce your account is created, you will be able to generate an API key from the IDC-Client portal. Separate API keys will be provided for the Sandbox and Production environment. You can access the API documentation from the Client portal as well. For further information, please contact us at [support@idcentral.io](https://desktop.postman.com/?desktopVersion=10.13.0&userId=25394574&teamId=1551387).\n\n## Base URL\n\n| **Environment** | **URL** |\n| --- | --- |\n| Sandbox |  |\n| Production | [https://api.idcentral.io/idc](https://desktop.postman.com/?desktopVersion=10.13.0&userId=25394574&teamId=1551387) |\n\n(**Note**: Production URL has been shown as '**baseUrl'** in endpoint URL)\n\n## Endpoints\n\nTo access the API, users can make HTTP requests to a designated endpoint URL, where GET or POST variables are used to specify the desired information. All endpoints are accessible via SSL-enabled HTTPS to ensure secure communication.\n\nThe IDcentral API utilizes appropriate HTTPS methods for every action to ensure secure and reliable data transmission between the client and the server.\n\n| **Method** | **Description** |\n| --- | --- |\n| GET | GET is used to request data from a specified resource |\n| POST | POST is used to send data to a server to create/update a resource |\n| DELETE | DELETE is used to delete data from the resource |\n\n## Authentication\n\nTo access the IDcentral API, the API key must be passed in the request header. The API key is provided upon request by the IDcentral team, and users can reach out to [support@idcentral.io](https://desktop.postman.com/?desktopVersion=10.13.0&userId=25394574&teamId=1551387) to obtain it. However, it is important to note that the API key should not be exposed on browser applications. If a browser application is being used, it is recommended to set up the API calls from the server side to ensure the security of the API key.\n\n## Errors and Status Codes\n\nIDcentral uses HTTP status codes to indicate the status of an API call, standard HTTP status code conventions are -\n\n- Status codes in the 2xx range mean success.\n    \n- Status codes in the 4xx range means there was an error in the provided information.\n    \n- Status Codes in the 5xx range indicate server-side errors.\n    \n\n| **Scenario** | **Status Code** | **Response Code** | **Status** | **Message** | **Error** |\n| --- | --- | --- | --- | --- | --- |\n| When the request has been successfully processed. This Indicates that the request has succeeded. | 200 | 1 | success | Successful Request |  |\n| If the request has been processed successfully but a response other than the expected HTTP status code for a valid successful scenario has been received. | 200 | 2-8 (Note: Response codes range from 2-8 indicate that request has been processed successfully but scenarios outside Status Code ”200” and Response Code “1” will be mapped. | success | Successful Request |  |\n| When request has been processed successfully but new response message / response code received. (All the mismatch error) | 200 | 9 | success |  |  |\n| When user exited the journey. | 200 | 10 | failed | **Note:** API specific message will be shown | **Note:** API specific message will be shown |\n| When invalid input has been entered. | 400 | \\-1 | failed | **Note:** API specific message will be shown | **Note:** API specific message will be shown |\n| When invalid credentials are given. | 401 | 70 | failed | **Note**: API specific message will be shown | Authentication Failed |\n| When no access has been provided to the user for particular API which user is trying. | 401 | 71 | failed | Please Contact Administrator for Access | No access |\n| When JWT token has expired. | 401 | 72 | failed |  | Token expired |\n| When account balance is exhausted. | 401 | 80 | failed | Kindly contact for assistance | Account balance exhausted |\n| When invalid endpoint URL is passed. | 404 | 0 | failed |  |  |\n| When invalid request method is passed. | 405 | 0 | failed | The request URL does not support the request method \\[METHOD NAME\\] used, use \\[METHOD NAME\\] | Request method invalid |\n| When rate limit threshold is hit. | 429 | 60 | failed | **Note**: API specific message will be shown | Rate Limited |\n| When unexpected internal server error occurs. | 500 | 88 | failed |  | Internal Error |\n| When unexpected error from partner / source occurs. | 500 | 99 | failed |  |  |\n\n(Note: Above errors are considered to be generic or common errors and may not  \nnecessarily apply to every API provided by IDcentral. It is important to note  \nthat each API may have its own unique set of errors and error codes. These  \nindividual errors have been mentioned in the API documentation provided for  \neach independent API.)\n\n**Backwards Compatibility**\n\nThe following modifications are classified as being backward compatible:\n\n1. Introducing new API endpoints.\n    \n2. Adding fresh attributes to the responses generated by existing API endpoints.\n    \n3. Appending optional parameters to the existing API endpoints.\n    \n4. Modifying the format or length of IDs.\n    \n5. Amending the message attributes communicated in case of validation failures or other errors.\n    \n6. Dispatching webhooks for new event types.\n    \n7. Rearranging the properties returned by the existing API endpoints.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32415637","team":1551387,"collectionId":"28a74a0f-2a52-47f9-80ef-5c13f6990dd3","publishedId":"2sA3e2fUhy","public":true,"publicUrl":"https://docs.idcentral.io","privateUrl":"https://go.postman.co/documentation/32415637-28a74a0f-2a52-47f9-80ef-5c13f6990dd3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/7e5baa22-093d-4766-a255-e7535bfba607/SURDIExvZ28ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/7e5baa22-093d-4766-a255-e7535bfba607/SURDIExvZ28ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-07-09T07:23:10.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/7e5baa22-093d-4766-a255-e7535bfba607/SURDIExvZ28ucG5n","logoDark":"https://content.pstmn.io/7e5baa22-093d-4766-a255-e7535bfba607/SURDIExvZ28ucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7032f2a6136a20a813b27a8b2e7eb3809d8fd42333274aeb8b10c0cafa93dd4e","favicon":"https://idcentral.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.idcentral.io/view/metadata/2sA3e2fUhy"}