{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9a2d86b7-a837-4de9-8302-3f37b628d40e","name":"Adjutor API Service","description":"Adjutor is an API-as-a-Service platform by Lendsqr, designed for lenders and fintechs looking to power their technology stack and enable critical lending capabilities.\n\nThe Adjutor API is structured around REST, featuring predictable, resource-oriented URLs. Our APIs accept JSON-encoded request bodies, return standard HTTP response codes with JSON-formatted responses, and use API key-based authentication for secure access.\n\nWith Adjutor, you can verify borrowers, score credit, automate collections, and manage both customers and loans through a unified API interface.\n\nA test mode is also available, allowing you to simulate requests without impacting live systems or production data.\n\n## Getting Started\n\nAccess to our APIs is easy.\n\n1. Sign up on the [Adjutor Web App](http://app.adjutor.io).\n    \n2. Navigate to the App section.\n    \n3. Select the services you want to access.\n    \n4. Create your API Key.\n    \n\n## Terms of Use\n\nTo use Lendsqr Adjutor APIs, you must agree to our [terms of use](https://adjutor.io/legal/terms-of-use). These terms outline the conditions under which you may access and use our API. Please review these terms carefully before using our API. If you have any questions or concerns about these terms, please contact us at [support@lendsqr.com](https://mailto:support@lendsqr.com).\n\n[You read about our terms here](https://adjutor.io/legal/terms-of-use).\n\n## Getting Support\n\nIf you require assistance at any time when using this documentation or the services, please email [support@lendsqr.com](https://mailto:support@lendsqr.com) and someone would be in touch with you as soon as possible. If you are currently using Lendsqr to lend, you can also contact your account manager at [growth@lendsqr.com](https://mailto:growth@lendsqr.com).\n\n---\n\n# Authentication\n\nAuthentication to the Adjutor API service is performed using an API key. Every endpoint requires authentication, so each request must include the following HTTP header:\n\n`Authorization: Bearer`\n\n`base_url: https://adjutor.lendsqr.com/v2/`\n\nThe resources an API key can access are determined by the API scope selected during the key’s creation. You can manage your API keys and their scopes, as well as toggle between live mode and test mode, directly within the [Adjutor web app](http://app.adjutor.io). This allows you to control which resources and environments your API key accesses.\n\n---\n\n# Data Types\n\nAll of the API responses returned are in JSON format, with these data types defined below:\n\n`string`  \nA UTF-8 encoded string\n\n`number`  \nAn integer\n\n`datetime`  \nAn ISO8601 encoded DateTime. All datetimes are returned in UTC with offset +00:00\n\n`decimal`  \nMonetary values are returned with up to two decimal places and may be positive or negative (e.g., 20.78, -32.50)\n\n---\n\n# Response\n\n**status** ˢᵗʳⁱⁿᵍ  \n_Indicates the result of the API call. Common values are \"success\" or \"error\"_\n\n**message** ˢᵗʳⁱⁿᵍ  \n_A descriptive message about the response._\n\n**data** ᵃʳʳᵃʸ  \nAn array containing various resource objects relevant to the request.\n\n**meta** ᵒᵇʲᵉᶜᵗ  \nIncludes additional context or details, such as pagination info, cost of API call and remaining balance.\n\n---\n\n# Errors\n\nErrors in Adjutor are communicated using standard HTTP status codes along with a JSON response body that provides additional details where available. You can generally rely on the HTTP status code alone to understand the outcome of a request.\n\nLike many modern APIs, Adjutor follows conventional HTTP response code practices: codes in the 2xx range indicate success, codes in the 4xx range represent client errors such as missing parameters or invalid requests, and codes in the 5xx range indicate rare server-side errors.\n\n## Error Response Fields\n\n**error_code** ⁱⁿᵗᵉᵍᵉʳ  \nA specific numeric code identifying the error type.\n\n**message** ˢᵗʳⁱⁿᵍ  \nA human-readable message as to the specifics of the problem.\n\n## **HTTP Status Code Summary**\n\n- `200` **OK** — _The request was successful, and everything worked as expected._\n    \n- `400` **Bad Request** — _The request was invalid or missing a required parameter._\n    \n- `401` **Unauthorized** — _No valid API key provided or authentication failed._\n    \n- `403` **Forbidden** — _Your API key does not have permission to perform the requested action._\n    \n- `404` **Not Found** — _The requested resource does not exist._\n    \n- `409` **Conflict** — _The request conflicts with another request, e.g, creating a user that already exists._\n    \n- `500`, `502`, `503`, `504` **Server Errors** — _Something went wrong on Adjutor's end._\n    \n\n# Beta or Experimental APIs\n\nWe experiment a lot at Lendsqr and some of our APIs are still under development. However, to aid, these APIs are marked with _\\[BETA\\]_ to denote their status. Please, do not use any of our beta APIs for production grade work as they may fail or have unexpected behaviors.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6202852","team":578475,"collectionId":"9a2d86b7-a837-4de9-8302-3f37b628d40e","publishedId":"2s93JrvPxp","public":true,"publicUrl":"https://api.adjutor.io","privateUrl":"https://go.postman.co/documentation/6202852-9a2d86b7-a837-4de9-8302-3f37b628d40e","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":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-04-13T13:53:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/e90121009004cd69e3f37cb507994bac417058018c0a402fd8eae9637a314b72","favicon":"https://adjutor.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://api.adjutor.io/view/metadata/2s93JrvPxp"}