{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"96665b5a-16ed-458c-b09e-e6c0ebf76aa7","name":"CreditParsePro","description":"# creditparsepro.io API endpoints\n\nEnable next-gen fintech innovations with creditparsepro: our API parses fixed-length credit reports from major US bureaus, delivering ML ready JSON data.\n\nBelow you will find our currently available API endpoints.\n\n[Website](https://www.granum-tech.com/products/creditparsepro/index.html)\n\n[Twitter](https://x.com/granum_tech)\n\n[GitHub](https://github.com/granum-tech/creditparsepro/blob/main/README.md)\n\n[Docs](https://github.com/granum-tech/creditparsepro/blob/main/docs/documentation.md)\n\n[Stripe Billing Portal](https://billing.stripe.com/p/login/14kaHj8NX5LJ5Ta8ww)\n\n## About\n\nAre you struggling to leverage credit report data effectively for analytics and machine learning? Many loan origination systems provide credit report data in a cumbersome, fixed-format text. This not only hampers your ability to perform in-depth analysis but also requires navigating through extensive documentation and complex logic to parse the data.\n\nIntroducing our API solution – the bridge to transforming traditional credit report data into a dynamic format ready for advanced fintech applications. Our software parses curated fields for both analytics and machine learning use-cases in a ready-to-use JSON format.\n\nUnlock the full potential of your data with our API, and step into a new era of financial technology applications. Say goodbye to outdated processes and embrace a future where your data works for you, enabling faster, more accurate decision-making.\n\n## **Version**\n\n- **Current Version**: 1.4.0\n    \n\n## Getting Started\n\n1. Use our Postman collection to test our API endpoints to ensure our product is right for you. And if you have further questions reach out to [info@granum-tech.com](https://mailto:info@creditparsepro.io).\n    \n2. Visit our [website](https://www.granum-tech.com/products/creditparsepro/index.html) and pick a free or paid subscription plan via our Stripe integration.\n    \n3. Receive an automated email with your API key via our SendGrid integration.\n    \n4. Review our [documentation](https://github.com/granum-tech/creditparsepro/blob/main/docs/documentation.md).\n    \n\n## Support\n\nPlease contact us at [info@granum-tech.com](https://mailto:info@creditparsepro.io) for support and inquiries.\n\n## **Authentication**\n\nAuthenticate each request by including the request header `x-api-key`. This was sent to you via Email when signing up.\n\nIt is okay to share your API key within your organization as there are no seat limits imposed only rate and quota limits.\n\nIn the case that a key is lost please email us from the email used to signup at [info@granum-tech.com](https://mailto:info@creditparsepro.io).\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n## **Quota & Rate Limits**\n\nAPI access rate and quota limits apply at a per-API key basis in unit time. The rate and quota you are offered depends on the product subscription tier that you chose. If you would like to upgrade you can do so at any time in the [Stripe billing portal](https://billing.stripe.com/p/login/14kaHj8NX5LJ5Ta8ww). You can see our detailed product offerings on our [website](https://www.granum-tech.com/products/creditparsepro/index.html).\n\nYou can check your current rate and quota limits using the GET requests [GET v1/quota-info](#get-v1quota-info) and [GET v1/rate-info](#get-v1rate-info).\n\nIf you either reach your quota or rate limit you will receive a 401 error message.\n\n## **Error & Response Messages**\n\nIf you receive a 200 response your request was successful. Otherwise potential errors are shown in the table below.\n\n| Error | Description |\n| --- | --- |\n| 400 | Bad Request: The request was malformed. Possibly due to a missing required parameter or a required parameter with an invalid value/data type. |\n| 401 | Unauthorized: The API key was missing or invalid. The rate or quota limit is at maximum. |\n| 500 | Internal Server Error: Likely an issue with the credit_report_text parameter formatting. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"34164250","collectionId":"96665b5a-16ed-458c-b09e-e6c0ebf76aa7","publishedId":"2sA3BgBFus","public":true,"publicUrl":"https://documenter-api.postman.tech/view/34164250/2sA3BgBFus","privateUrl":"https://go.postman.co/documentation/34164250-96665b5a-16ed-458c-b09e-e6c0ebf76aa7","customColor":{"top-bar":"2e3130","right-sidebar":"2e3130","highlight":"3f4ea6"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Convert fixed-format credit reports from major US bureaus into structured standardized JSON."},{"name":"title","value":"creditparsepro.io"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"2e3130","right-sidebar":"303030","highlight":"3f4ea6"}},{"name":"light","logo":null,"colors":{"top-bar":"2e3130","right-sidebar":"2e3130","highlight":"3f4ea6"}}]}},"version":"8.10.1","publishDate":"2025-01-17T01:23:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"creditparsepro.io","description":"Convert fixed-format credit reports from major US bureaus into structured standardized JSON."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Test","id":"495b5871-1c4d-4dfb-89f5-5a3c1c6ae0cc","owner":"34164250","values":[{"key":"x-api-key","value":"40f798ee1b57ec9d0513998c97a2a5bc","enabled":true,"type":"secret"}],"published":true}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"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"},{"label":"Test","value":"34164250-495b5871-1c4d-4dfb-89f5-5a3c1c6ae0cc"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3BgBFus"}