{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c3374a76-579b-4f2e-912a-39237b4ce11c","name":"Obligo API v0.1","description":"The Obligo API is organized around REST and uses traditional HTTP request methods and response codes. Our API accepts form-encoded requests and returns JSON-encoded responses.\n\nFeel free to contact us via [support@myobligo.com](mailto:support@myobligo.com) if you have questions.  \n  \n  \n\n* * *\n\n# Testing\n\nYou can test the Obligo API using our Sandbox environment.  \n  \nIt works exactly like the production environment and allows you to test your code prior to going live.\n\nThe base URL for the Sandbox environment is [https://api.sandbox.myobligo.com/](https://api.sandbox.myobligo.com/)  \n  \n  \n\n* * *\n\n# Metadata\n\nThe Obligo API supports passing key-value metadata objects on all resources.  \n  \nIf you need to match a certain resource on the Obligo API to one of you internal resources, the metadata object is where you would want to represent that.\n\nFor example, a metadata object may look like this:  \n\n```\n{\n   “myForeignKey”: “4e82b0c2-63b2-4be4-ae3e-5f716edac928”\n}\n\n```\n\n  \n  \nA metadata value can be of one of the following types: String, Number or Boolean  \n  \n\n* * *\n\n# Commonly Used Data Types\n\n### Address\n\nDescribes a single address  \n  \n\n| Attribute | Type | Description |\n| --- | --- | --- |\n| line | String | Address line |\n| city | String | City |\n| state | String | A two letter state name (ISO) |\n| country | String | A two letter country name (ISO Alpha-2) |\n| postalCode | String | Postal code |\n\n* * *\n\n# Pagination, Sorting and Search\n\nThe Obligo API supports pagination, sorting and search functionalities for all `list` requests for our resources.  \n  \nAll parameters should be passed in the query string for `GET` requests and in the body for `POST` requests. (some resources allow listing with a `POST` method)  \n  \n  \n\n### Pagination\n\n| Parameter | Min | Max | Default | Description |\n| --- | --- | --- | --- | --- |\n| offset | 0 | \\- | 0 | Indicate the starting point to return rows from a result set |\n| limit | 1 | 100 | 10 | How many items should return in the result set |\n\n### Sorting\n\n| Parameter | Description |\n| --- | --- |\n| sortBy | Which field to sort by, inner fields should be represented by a separating dot |\n| descending | Whether the result set should be ordered from top to bottom |\n\n### Searching\n\n| Parameter | Description |\n| --- | --- |\n| search | The term used to search the data |\n\n* * *\n\n# Idempotency Identifiers\n\nThe Obligo API allows users to pass an idempotency identifier with the request.  \n  \nThis way a sensitive action will not be performed more than once by mistake.\n\nIdempotency works by caching the response for a certain request for the provided identifier, including cases of unexpected errors (`500`).  \n  \nThe cashed responses expire after 24 hours.\n\nFor example:  \n  \nWhen you request a risk analysis on a certain tenant, with an idempotency identifier, and the request results in a successful response (`200`), that response will be cached.  \n  \nAll subsequent requests with that same identifier will yield the same successful response, without actually executing the action again.\n\nYou may pass the idempotency identifier in the query string as follows:  \n  \n`...&idempotencyId=...`\n\nIdempotency identifiers are available for all `POST` methods. Avoid passing the idempotency identifier for `GET` and `DELETE` methods.  \n  \n  \n\n* * *\n\n# Errors\n\nThe Obligo API uses the following error codes:\n\n| Error Code | Meaning |\n| --- | --- |\n| 400 | Bad Request -- Your request is invalid |\n| 401 | Unauthorized -- Your API token is invalid or it needs to be refreshed |\n| 403 | Forbidden -- You are not allowed to access the requested resource |\n| 404 | Not Found -- The specified resource could not be found |\n| 405 | Method Not Allowed -- You tried to access a resource with an invalid HTTP method |\n| 409 | Conflict -- The request conflicts with the current state of the server |\n| 423 | Locked -- The resource that is being accessed is locked |\n| 429 | Too Many Requests -- You've gone over your request limit |\n| 500 | Internal Server Error -- We had a problem with our server. Try again later |\n| 503 | Service Unavailable -- We're temporarily offline for maintenance. Try again later |\n\n* * *\n\n# Important Notes\n\nThere are few important things you need to know when working with the Obligo API:\n\n*   All variables are camelCase.\n*   Money is counted in cents in our platform - a variable named `amount` with a value of `250000` would represent an amount equal to `250,000 cents` or `$2,500`.\n*   All types and statuses are capitalized. Some examples: `BillingAuthorization`, `CashDeposit`, `Approved`, `Canceled`, etc…\n*   All date-time fields are formatted as ISO 8601 strings\n    \n\n* * *\n\n# Authentication\n\nThe authentication to the Obligo API is performed using HTTP Basic Auth.\n\nWe provide you with a `client ID` and `client secret`, which you'll use to build your API authentication key. In order to build your API authentication key you will need to follow these steps:\n\n*   Concat the client ID and secret with a colon between them \"clientId:clientSecret\"\n*   Encode the concatinated string to base 64\n    \n\nThe API key is expected to be included in all API requests using a basic token header, in the following way:  \n  \n`Authorization: Basic Qdahjk47892743...`\n\nYour API secret keys must be kept securely! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc...","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3973695","team":197058,"collectionId":"c3374a76-579b-4f2e-912a-39237b4ce11c","publishedId":"SW7Z3U3Z","public":true,"publicUrl":"https://doc01.myobligo.com","privateUrl":"https://go.postman.co/documentation/3973695-c3374a76-579b-4f2e-912a-39237b4ce11c","customColor":{"top-bar":"FFFFFF","right-sidebar":"182040","highlight":"23C9F7"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-01-05T10:22:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production (Public)","id":"3effb3b8-7eb0-4ab2-990b-9e54c8df650e","owner":"3973695","values":[{"key":"apiHost","value":"https://api.myobligo.com","enabled":true},{"key":"apiKey","value":"YOUR_API_KEY","enabled":true},{"key":"__todayDate","value":"","enabled":true,"type":"any"},{"key":"__YearFromNowDate","value":"","enabled":true,"type":"any"}],"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/25e9ca2c01f9715d2d998af1e704d8617e75351dd3bdea2eabddf3d96f6632db","favicon":"https://res.cloudinary.com/postman/image/upload/v1641378532/team/zeuks2qmbllg28sulygf.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"},{"label":"Production (Public)","value":"3973695-3effb3b8-7eb0-4ab2-990b-9e54c8df650e"}],"canonicalUrl":"https://doc01.myobligo.com/view/metadata/SW7Z3U3Z"}