{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5ee2b5b2-7020-43e0-8659-9ee92dbf4f6e","name":"CreditScale Credit Data API","description":"CreditScale's Credit Data API is a RESTful, JSON based API. It contains resource-oriented URLs and uses HTTP features for authentication and communication. In addition to providing raw data, printable credit reports are also available in HTML and PDF formats. \n\n# Overview\nA credit report is comprised of several sections. The major ones are scores, liabilities (also known as tradelines), inquiries, and summaries. Credit Data API contains resources for each of these sections.\n\nThe root resource (/credit) returns all available data. Most sub-resources are available for each of the major sections. Sub-resources are queriable via URL parameters for ease of filtering. In addition, URL aliases are available for a select number of popular queries.\n\n# Authentication\nAn API Key is required for access. You can create one by signing up for a free developer account [here](https://creditscale.io/signup).  \n\nAuthentication is performed by sending in a Basic Authentication header with your API key as the username. The password portion is to be left empty. The username and colon should be Base-64 encoded prior to sending the request.\n\nFor example:\nAuthorization: Basic xxxxxxx:\n\n\nThere are two types of API keys, test (sandbox) and production API keys. Test API keys will only work in the test environment and cannot be switched over to the production environment. A production key will be provided and will also appear in your dashboard once your integration is complete.\n\n# Download the Postman Collection\nOnce you have created your API key, download the Postman Collection by clicking the button below.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/89009dfdc7e1356a0ec9#?env%5BFor%20Publishing%5D=W3sia2V5IjoiYXV0aEtleSIsInZhbHVlIjoieW91cl90ZXN0X2FwaV9rZXkiLCJkZXNjcmlwdGlvbiI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaG9zdCIsInZhbHVlIjoic2FuZGJveC1hcGkuY3JlZGl0c2NhbGUuaW8iLCJkZXNjcmlwdGlvbiI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidmVyc2lvbiIsInZhbHVlIjoidjEiLCJkZXNjcmlwdGlvbiI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicHJvZHVjdCIsInZhbHVlIjoiY3JlZGl0IiwiZGVzY3JpcHRpb24iOiIiLCJlbmFibGVkIjp0cnVlfV0=)\n\n# Errors\n## HTTP Response Codes\nStandard HTTP response codes are used for successful and failed transactions.\n* 200 - Ok\n* 201 - Created\n* 304 - Not Modified\n* 400 - Bad Request\n* 401 - Unauthorized\n* 404 - Not Found\n* 405 - Method Not Allowed\n* 415 - Unsupported Media Type\n* 429 - Too many requests\n* 500 - Internal Server Error\n\n## Response Body\nIn addition to the HTTP code response, an array of json objects will be returned in the response body. Each json object conforms to [RFC 7807](https://tools.ietf.org/html/rfc7807) and contains at least the following fields:\n\n* title\n* detail\n* status\n\nFor example:\n```json\n[\n\t{\n\t\t\"title\": \"Bad Request\",\n\t\t\"detail\": \"this message can be shown to the client\",\n\t\t\"status\": 400\n\t}\n]\n```\n\n# Rate limit\nPlease limit your requests to 1 request a second.\n\n# Versioning\nCredit Data API will only be up-versioned when a breaking change is made. A breaking change includes:\n* Renaming or removing properties from the response format.\n* Editing the response data types. Like changing a value from a string to an integer type. \n* Removing or modifying URLs.\n* Removing or editing query parameters.\n\nNon-breaking changes include:\n* Adding new properties to the response data\n* Sorting properties within a response data\n* Adding new URLs\n* Adding new query parameters\n\nThese changes can be made to the current version. Please make sure your application can handle these updates without issue.\n\nVersioning is handled in Credit Data API through the URL. \nFor example:\napi.creditscale.io/v1\napi.creditscale.io/v2\n\n## Available versions\n### v1\nRelease Date: 1/17/2019\nChanges\n - Initial release\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3379028","team":321150,"collectionId":"5ee2b5b2-7020-43e0-8659-9ee92dbf4f6e","publishedId":"S17xr5ZJ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/3379028/S17xr5ZJ","privateUrl":"https://go.postman.co/documentation/3379028-5ee2b5b2-7020-43e0-8659-9ee92dbf4f6e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-05-07T21:23:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Sandbox","id":"53a6f723-b9ce-4282-a71f-f36e68a307ac","owner":"3379028","values":[{"key":"authKey","value":"your_test_api_key","description":"","enabled":true},{"key":"host","value":"sandbox-api.creditscale.io","description":"","enabled":true},{"key":"version","value":"v1","description":"","enabled":true},{"key":"product","value":"credit","description":"","enabled":true}],"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/6c751ff270719436d985969593cbbff2a18f2d2b83973c92cddd77ab31f23b57","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":"Sandbox","value":"3379028-53a6f723-b9ce-4282-a71f-f36e68a307ac"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/S17xr5ZJ"}