{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6fda84ed-b072-437c-bb57-ce5a9e3c60bf","name":"CRiskCo Approve API - Full tests","description":"<img src=\"https://www.criskco.com/wp-content/uploads/2020/01/CRisk-Co-Logo.png\" alt=\"\">\n\nCRiskCo’s API is organized around REST. Accounts have test mode and live mode API keys. There is no \"switch\" for changing between modes, use the appropriate key to perform a live or test transaction. Requests made with test mode credentials incur no cost. JSON is returned by all API responses, including errors.  \nBe sure to subscribe to CRiskCo's API mailing list at [api@criskco.com](https://mailto:api@criskco.com), to receive information on new additions and changes to CRiskCo’s API libraries.\n\nThis document outlines the CRiskCo programmatic interface (API) for Credit providers who use CRiskCo@Approve or CRiskCo@Gov platform to onboard applicants and do on-going monitoring. Using the API, the credit providers can access financial data (including accounting information), analytics, and CRiskCo Credit reports.  \nCRiskCo’s API libraries are documented in different documents. Each document provides a set of API calls per topic or set of data elements. Be sure to explore CRiskCo ’s libraries to get a full picture of CRiskCo’s available data.\n\n### Jargon\n\nFor ease of understanding, the following jargon will be used throughout the document:\n\n1. Credit Provider – refers to the entity/app that is calling the API.\n2. Applicant – refers to the business applicant who applies for credit from the Credit Provider. This is normally a business that is signed up with the Credit Provider and applies for credit as a loan, Insurance, Grant or line of credit.\n3. Customer – refers to a business entity that is the customer of the Applicant. A Customer may be an Applicant too in a different session.\n    \n\n### At a glance\n\nThe flow to receive an applicant credit and financial information from the API:\n\n1. Applicant applies online for credit and is referred to the dedicated white label landing page URL provided by CRiskCo. Applicant will go through the application process, with the last step is choosing an accounting system and authorize CRiskCo access through the accounting system API.\n2. CRiskCo backend will load the Applicant’s accounting information from the accounting system and prepare a full credit report and summarize the financial information to be transmitted over the API.\n3. Once this process completes, Applicant will be redirected to the resumeUrl (provided by the Credit Provider upon registration) with a parameter that will be used to reference Applicant in future API calls as described in this document.\n    \n4. Credit Provider will use his API keys to make calls to the CRiskCo API.\n    \n\n# Get your API Keys\n\n### Developer Registration\n\nTo start developing, register with CRiskCo to receive access to your own Sandbox.  \nRegister [HERE](https://www.criskco.com/en/developers-open-accounting-api/) to immediately get your credentials.\n\nAfter your register, you will be provided access to development API tokens and can start making calls to the API.\n\nTokens Provided:\n\n1. apiId - Unique ID assigned for each Credit Provider by CRiskCo.\n2. apiKey - Unique token used to identify the Credit Provider during API calls.\n    \n\n# Authentication\n\n#### Request Format\n\nRequests must include the following headers:\n\n1. apiId\n2. apiKey\n3. Content-Type: application/JSON\n    \n\nIf request parameters are required in a request, the parameters must be sent in the request body and in JSON format, according to the endpoint definition.\n\nAll API responses are in JSON format.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9581589","collectionId":"6fda84ed-b072-437c-bb57-ce5a9e3c60bf","publishedId":"UVkjwdHJ","public":true,"publicUrl":"https://api-docs.criskco.com.mx","privateUrl":"https://go.postman.co/documentation/9581589-6fda84ed-b072-437c-bb57-ce5a9e3c60bf","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-12-26T12:01:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/ac2c46e3a72525cf0ac7b29eb4b3504d7b60c5b2d57dd0c764f951f0212aa3be","favicon":"https://criskco.com.mx/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://api-docs.criskco.com.mx/view/metadata/UVkjwdHJ"}