![\"Lease](\"https://cdn.myobligo.com/img/api-docs/lease-flow-1.png\")
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.
\nFeel free to contact us via support@myobligo.com if you have questions.
\nYou can test the Obligo API using our Sandbox environment.
\nIt works exactly like the production environment and allows you to test your code prior to going live.
\nThe base URL for the Sandbox environment is https://api.sandbox.myobligo.com/
\nThe Obligo API supports passing key-value metadata objects on all resources.
\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.
\nFor example, a metadata object may look like this:
\n{\n “myForeignKey”: “4e82b0c2-63b2-4be4-ae3e-5f716edac928”\n}\n\nA metadata value can be of one of the following types: String, Number or Boolean
\nDescribes a single address
\nThe Obligo API supports pagination, sorting and search functionalities for all list requests for our resources.
All 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)
The Obligo API allows users to pass an idempotency identifier with the request.
\nThis way a sensitive action will not be performed more than once by mistake.
\nIdempotency works by caching the response for a certain request for the provided identifier, including cases of unexpected errors (500).
The cashed responses expire after 24 hours.
\nFor example:
\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.
All subsequent requests with that same identifier will yield the same successful response, without actually executing the action again.
\nYou may pass the idempotency identifier in the query string as follows:
\n...&idempotencyId=...
Idempotency identifiers are available for all POST methods. Avoid passing the idempotency identifier for GET and DELETE methods.
The Obligo API uses the following error codes:
\nThere are few important things you need to know when working with the Obligo API:
\namount with a value of 250000 would represent an amount equal to 250,000 cents or $2,500.BillingAuthorization, CashDeposit, Approved, Canceled, etc…The authentication to the Obligo API is performed using HTTP Basic Auth.
\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:
The API key is expected to be included in all API requests using a basic token header, in the following way:
\nAuthorization: Basic Qdahjk47892743...
Your 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...
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Testing","slug":"testing"},{"content":"Metadata","slug":"metadata"},{"content":"Commonly Used Data Types","slug":"commonly-used-data-types"},{"content":"Pagination, Sorting and Search","slug":"pagination-sorting-and-search"},{"content":"Idempotency Identifiers","slug":"idempotency-identifiers"},{"content":"Errors","slug":"errors"},{"content":"Important Notes","slug":"important-notes"},{"content":"Authentication","slug":"authentication"}],"owner":"3973695","collectionId":"c3374a76-579b-4f2e-912a-39237b4ce11c","publishedId":"SW7Z3U3Z","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"182040","highlight":"23C9F7"},"publishDate":"2022-01-05T10:22:44.000Z"},"item":[{"name":"Accounts","item":[{"name":"Get account","id":"8e456c3c-d8be-4902-86c7-43b2e8b4e0bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKeyV01}}","type":"text"}],"url":"{{apiHost}}/v0.1/accounts/:accountId","urlObject":{"path":["v0.1","accounts",":accountId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The account ID
\n","type":"text/plain"},"type":"string","value":"7d50dfe3-03cf-4513-b292-a3ed7bbba132","key":"accountId"}]}},"response":[{"id":"720912bb-c2fc-4c71-9d6e-fc5bf6c370a0","name":"Get account data","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/accounts/:accountId","host":["{{apiHost}}"],"path":["v0.1","accounts",":accountId"],"variable":[{"key":"accountId","value":"961065c9-0647-4ec7-b9a1-11abc5fbb2cc","description":"The account ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"649"},{"key":"Connection","value":"keep-alive"},{"key":"x-response-time","value":"249ms"},{"key":"Date","value":"Thu, 14 Nov 2019 07:01:54 GMT"},{"key":"X-Kong-Upstream-Latency","value":"253"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"961065c9-0647-4ec7-b9a1-11abc5fbb2cc\",\n \"referenceCode\": \"F5L5KJ059\",\n \"name\": \"Demos Account\",\n \"active\": true,\n \"metadata\": {},\n \"createdAt\": \"2019-03-12T22:34:01.000Z\",\n \"updatedAt\": \"2019-11-14T04:47:59.000Z\"\n}"}],"_postman_id":"8e456c3c-d8be-4902-86c7-43b2e8b4e0bf"},{"name":"List accounts","id":"f5e8d491-3ca4-4fb3-882a-b5383cf28661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiHost}}/v0.1/accounts","urlObject":{"path":["v0.1","accounts"],"host":["{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"56c0c42a-c14b-4fe7-bd89-fb3a03a97f23","name":"Show first 10 results","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/accounts?limit=10&offset=0","host":["{{apiHost}}"],"path":["v0.1","accounts"],"query":[{"key":"limit","value":"10","description":"How many items should return in the result set"},{"key":"offset","value":"0","description":"Indicate the starting point to return rows from a result set"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"215"},{"key":"Connection","value":"keep-alive"},{"key":"x-response-time","value":"344ms"},{"key":"Date","value":"Thu, 14 Nov 2019 05:23:40 GMT"},{"key":"X-Kong-Upstream-Latency","value":"352"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [...],\n \"totalItems\": 1\n}"},{"id":"51116ec8-57d6-4d26-accb-f40755224450","name":"List connected accounts (coming soon)","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{apiHost}}/v0.1/accounts?connected=true","host":["{{apiHost}}"],"path":["v0.1","accounts"],"query":[{"key":"connected","value":"true"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"items\": [...],\n \"totalItems\": 1\n}"}],"_postman_id":"f5e8d491-3ca4-4fb3-882a-b5383cf28661"},{"name":"Create account (coming soon)","id":"40be6b28-dc5c-4ee2-a830-fc3320676377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/accounts","urlObject":{"path":["v0.1","accounts"],"host":["{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"2a8ab9a7-8cc2-4b4f-9c59-81951e1f9892","name":"Create connected account","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"New Connected Account","type":"text"},{"key":"metadata[customId]","value":"123456789","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"{{apiHost}}/v0.1/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3a36a185-d0e8-4718-9f4a-0bca944724c1\"\n}\n"}],"_postman_id":"40be6b28-dc5c-4ee2-a830-fc3320676377"},{"name":"Update account (coming soon)","id":"75b3b54d-27c8-4249-91de-5ef4ac32b509","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{apiHost}}/v0.1/accounts/:accountId","urlObject":{"path":["v0.1","accounts",":accountId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The account ID
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[{"id":"dc51ce35-69a3-4512-9d31-e8ed7f8e99b8","name":"Update account name and metadata","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"New Account Name","type":"text"},{"key":"metadata[customKey]","value":"New Value","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/accounts/:accountId","host":["{{apiHost}}"],"path":["v0.1","accounts",":accountId"],"variable":[{"key":"accountId","value":"9b71efe7-7f4f-40fb-bc3e-1b0ea45577dc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"updated\": true\n}"}],"_postman_id":"75b3b54d-27c8-4249-91de-5ef4ac32b509"}],"id":"9208322f-a796-49f6-a5ee-7933e1f1480c","description":"Accounts are the root entities in the Obligo API. When generating a private app for a single integration, you will have access to only one account. However, if you’re building a public app, you will have access to multiple accounts.\n
The account ID
\n","type":"text/plain"},"type":"string","value":"","key":"accountId"}]}},"response":[{"id":"0fa03dfd-3633-4d1f-96c3-d8358f965aaf","name":"List account payment types","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/accounts/:accountId/payment-types","host":["{{apiHost}}"],"path":["v0.1","accounts",":accountId","payment-types"],"variable":[{"key":"accountId","value":"","description":"The account ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"215"},{"key":"Connection","value":"keep-alive"},{"key":"x-response-time","value":"344ms"},{"key":"Date","value":"Thu, 14 Nov 2019 05:23:40 GMT"},{"key":"X-Kong-Upstream-Latency","value":"352"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"id\": \"d299fd59-0fe3-4222-8d81-be1a416fff93\",\n\t\t\"type\": \"RentAdvance\",\n\t\t\"description\": \"First Month's Rent\"\n\t},\n\t{\n\t\t\"id\": \"ff836b44-3141-41d8-ac6e-bc66bc5ff4d9\",\n\t\t\"type\": \"PetFee\",\n\t\t\"description\": \"Pet Fee\"\n\t}\n]"}],"_postman_id":"540d9eb3-bbe6-4911-8cbb-bfde7234de33"}],"id":"e8d1041c-cd77-4380-967e-516d89a9d115","description":"Payment types are used to categorize the different possible payments for the account and are a subresource of accounts.\n
The asset ID
\n","type":"text/plain"},"type":"string","value":"","key":"assetId"}]}},"response":[{"id":"6c46176c-8ecd-4a03-8616-c64645975e3c","name":"Get a specific asset","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/assets/:assetId","host":["{{apiHost}}"],"path":["v0.1","assets",":assetId"],"variable":[{"key":"assetId","value":"","type":"string","description":"The asset ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"8ca3711d-2063-4b07-9336-ee48f2a3ee43\",\n\t\"accountId\": \"30853db4-18ac-43dc-b00b-e119d24e8c2c\",\n\t\"referenceCode\": \"SCKTKD232\",\n\t\"type\": \"MultiFamily\",\n\t\"name\": \"34 Broadway street\",\n\t\"displayName\": \"34 Broadway street\",\n\t\"address\": {\n\t \"line\": \"34 Broadway\",\n\t \"city\": \"New York\",\n\t \"state\": \"NY\",\n\t \"country\": \"US\",\n\t \"postalCode\": \"10006\"\n\t},\n\t\"metadata\": {},\n\t\"createdAt\": \"2019-03-6T22:34:01.000Z\",\n\t\"updatedAt\": \"2019-03-18T04:47:59.000Z\"\n}"}],"_postman_id":"2ac7d040-7fe9-4a99-88fe-08dfa2fced33"},{"name":"List assets","id":"cc4c27aa-559a-4f78-85d8-c06582f55a62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/assets","urlObject":{"path":["v0.1","assets"],"host":["{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"4af013bf-6e12-4753-a2b3-f7c847219746","name":"List the first 10 assets","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/assets?offset=0&limit=10&sortBy=displayName&descending=false","host":["{{apiHost}}"],"path":["v0.1","assets"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"10"},{"key":"sortBy","value":"displayName"},{"key":"descending","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"totalItems\": 2,\n\t\"items\": [...]\n}"},{"id":"7b54fe04-b732-40ed-83a8-3ff1e26540df","name":"List connected account assets (coming soon)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"},{"key":"X-Account-Id","value":"4b0de4ae-c765-43b8-8af7-862bdb2b6c16","type":"text"}],"url":"{{apiHost}}/v0.1/assets"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"totalItems\": 2,\n\t\"items\": [...]\n}"}],"_postman_id":"cc4c27aa-559a-4f78-85d8-c06582f55a62"},{"name":"Create asset (coming soon)","id":"15e65816-410b-4c96-a674-26ba63cfc83a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/assets","urlObject":{"path":["v0.1","assets"],"host":["{{apiHost}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"15e65816-410b-4c96-a674-26ba63cfc83a"},{"name":"Update asset","id":"ccf38359-bb2a-4343-bb52-67d041d64738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{currentAccessToken}}"},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"settings\":{\"addressLeaseMapping\": {\"addressFromIntegration\": true}}\n}","options":{"raw":{"language":"json"}}},"url":"{{apiHost}}/api/v0.1/assets/:assetId","urlObject":{"path":["api","v0.1","assets",":assetId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The asset ID
\n","type":"text/plain"},"type":"string","value":"{{assetId}}","key":"assetId"}]}},"response":[{"id":"e976b0d7-01ca-447a-a1e0-31ccdd91d8c4","name":"Update connected account asset metadata (coming soon)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"X-Account-Id","value":"4b0de4ae-c765-43b8-8af7-862bdb2b6c16","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"metadata[myForeignKey]","value":"123456789","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/assets/:assetId","host":["{{apiHost}}"],"path":["v0.1","assets",":assetId"],"variable":[{"key":"assetId","value":"","type":"string","description":"The asset ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"ccf38359-bb2a-4343-bb52-67d041d64738"}],"id":"bfcf30d4-dd22-447c-b477-2b7ba4bfe3f0","description":"Assets are entities that represent actual assets related to the account such as a multi family building or a portfolio of single family homes.
\nThere are currently two types of assets: MultiFamily and Portfolio. The difference between them is that a MultiFamily asset has an address and Portfolio doesn’t.
\nWhen creating a lease on a Portfolio asset, you will have to supply an address as well.\n
The business name, must be at least 5 characters.
\n","type":"text"},{"key":"type","value":"string (required)","description":"On of the following: Company, Individual
\n","type":"text"},{"key":"subType","value":"String","description":"One of the following company sub types: CORP, LLC, SOLE-PROPRIETORSHIP, Estate, IRA, TRUST
\n","type":"text"},{"key":"address","value":"Address","description":"An object containing information about the address of the beneficiary
\n","type":"text"},{"key":"taxId","value":"String","description":"EIN construct of a 9 characters string
\n","type":"text"},{"key":"phoneNumber","value":"String","description":"The phone number associated with the beneficiary
\n","type":"text"},{"key":"email","value":"string","description":"An email address associated to the beneficiary
\n","type":"text"},{"key":"dob","value":"Date","description":"Beneficiary's date-of-birth(individual)/formation-date(company
\n","type":"text"},{"key":"representatives","value":"[Representative]","description":"An array of objects containing information about the beneficiary's representatives
\n","type":"text"},{"key":"metadata","value":"Object","description":"Set of key-value data that can be attached to an account, may be used for any additional information necessary.
\n","type":"text"}]},"url":"{{apiHost}}/v0.1/account/:accountId/beneficiaries","urlObject":{"path":["v0.1","account",":accountId","beneficiaries"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The account id
\n","type":"text/plain"},"type":"any","value":"uuid (required)","key":"accountId"}]}},"response":[],"_postman_id":"40a98e3b-d351-4094-ac5d-fbab425ea410"},{"name":"Add representative","id":"bd063b6b-adb0-4ed8-b454-b5d9a7059fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","type":"text","value":"string"},{"key":"lastName","type":"text","value":"string"},{"key":"ssnLastFour","type":"text","value":"String"},{"key":"phoneNumber","type":"text","value":"String"},{"key":"email","type":"text","value":"string (required)"},{"key":"dob","type":"text","value":"Date"}]},"url":"{{apiHost}}/v0.1/beneficiary/:beneficiaryId/representative","urlObject":{"path":["v0.1","beneficiary",":beneficiaryId","representative"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The beneficiary id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"beneficiaryId"}]}},"response":[],"_postman_id":"bd063b6b-adb0-4ed8-b454-b5d9a7059fbc"},{"name":"Update representative","id":"232140d2-e117-43d4-8ee7-ca34d3854544","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","type":"text","value":"string"},{"key":"lastName","type":"text","value":"string"},{"key":"ssnLastFour","type":"text","value":"String"},{"key":"phoneNumber","type":"text","value":"String"},{"key":"dob","type":"text","value":"Date"}]},"url":"{{apiHost}}/v0.1/beneficiary/:beneficiaryId/representative/:representativeId","urlObject":{"path":["v0.1","beneficiary",":beneficiaryId","representative",":representativeId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The beneficiary id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"beneficiaryId"},{"description":{"content":"The representative id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"representativeId"}]}},"response":[],"_postman_id":"232140d2-e117-43d4-8ee7-ca34d3854544"},{"name":"Update beneficiary","id":"9e2bd3fe-5d67-41a4-b358-7ef618da4928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"string (required)","description":"The business name, must be at least 5 characters.
\n","type":"text"},{"key":"type","value":"string (required)","description":"On of the following: Company, Individual
\n","type":"text"},{"key":"subType","value":"String","description":"One of the following company sub types: CORP, LLC, SOLE-PROPRIETORSHIP, Estate, IRA, TRUST
\n","type":"text"},{"key":"address","value":"Address","description":"An object containing information about the address of the beneficiary
\n","type":"text"},{"key":"taxId","value":"String","description":"EIN construct of a 9 characters string
\n","type":"text"},{"key":"phoneNumber","value":"String","description":"The phone number associated with the beneficiary
\n","type":"text"},{"key":"email","value":"string","description":"An email address associated to the beneficiary
\n","type":"text"},{"key":"dob","value":"Date","description":"Beneficiary's date-of-birth(individual)/formation-date(company
\n","type":"text"},{"key":"metadata","value":"Object","description":"Set of key-value data that can be attached to an account, may be used for any additional information necessary.
\n","type":"text"}]},"url":"{{apiHost}}/v0.1/beneficiaries/:beneficiaryId","urlObject":{"path":["v0.1","beneficiaries",":beneficiaryId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The beneficiary id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"beneficiaryId"}]}},"response":[],"_postman_id":"9e2bd3fe-5d67-41a4-b358-7ef618da4928"},{"name":"Get beneficiary","id":"0a591ef1-e48d-4c1d-9a42-8fe99c34f584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{apiHost}}/v0.1/beneficiaries/:beneficiaryId","description":"Get beneficiary by his Id.
\nIf succeed, return the beneficiary object.
Return an error in case of non exist beneficiary id.
The beneficiary id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"beneficiaryId"}]}},"response":[],"_postman_id":"0a591ef1-e48d-4c1d-9a42-8fe99c34f584"},{"name":"List beneficieries","id":"b224c398-f1b6-4bdd-bc2f-97afb2aa71ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{apiHost}}/v0.1/accounts/:accountId/beneficiaries?sortBy=string&offset=integer&limit=integer&descending =boolean","description":"Get a list of all the beneficiaries of your account.
\nsearch (optional)
\nlimit (optional)
\nLimit the number of objects to be returned.
\noffset (optional)
\nMark the starting index of the returned objects, the objects that returns will be the only objects that come after this index. For example if you set it to 10 in a 20 objects list, only the 10 last objects in the list will be returned.
\nsortBy (optional)
\nSort the list by one of the beneficiary data type attributes.
Default is list sorted by beneficiary creation time.
descending (optional)
Boolean for sorting the list in descending order. Default is sorted in ascending order.
Return a list of beneficiary objects, filtered by the parameters.
\n","urlObject":{"path":["v0.1","accounts",":accountId","beneficiaries"],"host":["{{apiHost}}"],"query":[{"description":{"content":"Supported values: 'id', 'name' and the various timestamp fields (default 'createdAt')
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"A non negative value to offset the start the list by (default is 0)
\n","type":"text/plain"},"key":"offset","value":"integer"},{"description":{"content":"A non negative value to limit the number of results to
\n","type":"text/plain"},"key":"limit","value":"integer"},{"description":{"content":"A boolean inducating whether the result set should be ordered from top to bottom (default is false)
\n","type":"text/plain"},"key":"descending ","value":"boolean"}],"variable":[{"description":{"content":"The account id
\n","type":"text/plain"},"type":"any","value":"","key":"accountId"}]}},"response":[],"_postman_id":"b224c398-f1b6-4bdd-bc2f-97afb2aa71ff"}],"id":"5651e491-5a89-4bb0-be3b-8bb0408944c2","description":"The bank account number
\n","key":"accountNumber","type":"text","value":"string (required)"},{"description":"The bank account routing number
\n","key":"routingNumber","type":"text","value":"string (required)"},{"description":"Name of the bank account holder as defined in the bank
\n","key":"holderName","type":"text","value":"String (required)"},{"description":"The name of the payment method
\n","key":"title","type":"text","value":"String"}]},"url":"{{apiHost}}/v0.1/beneficiary/:beneficiaryId/payment-methods","urlObject":{"path":["v0.1","beneficiary",":beneficiaryId","payment-methods"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The beneficiary id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"beneficiaryId"}]}},"response":[],"_postman_id":"31c517de-78e1-4acd-9912-3310ba1294cb"},{"name":"Update payment method","id":"683cce47-6e4f-411a-8844-2972607d726d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"The name of the payment method
\n","key":"title","type":"text","value":"String"},{"key":"metadata","value":"Object","description":"Set of key-value data that can be attached to an account, may be used for any additional information necessary.
\n","type":"text"}]},"url":"{{apiHost}}/v0.1/payment-methods/:paymentMethodId","urlObject":{"path":["v0.1","payment-methods",":paymentMethodId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The payment method id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"paymentMethodId"}]}},"response":[],"_postman_id":"683cce47-6e4f-411a-8844-2972607d726d"},{"name":"Get payment method","id":"b8ef034e-c060-4f6e-8f2b-7fb154484f8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/payment-methods/:paymentMethodId","urlObject":{"path":["v0.1","payment-methods",":paymentMethodId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The payment method id
\n","type":"text/plain"},"type":"any","value":"uudi","key":"paymentMethodId"}]}},"response":[],"_postman_id":"b8ef034e-c060-4f6e-8f2b-7fb154484f8b"},{"name":"List payment methods","id":"ed2d8caa-f8a3-44ee-91c6-97e1952fda3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{apiHost}}/v0.1/beneficiary/:beneficiaryId/payment-methods?sortBy=string&offset=integer&limit=integer&descending =boolean","urlObject":{"path":["v0.1","beneficiary",":beneficiaryId","payment-methods"],"host":["{{apiHost}}"],"query":[{"description":{"content":"Supported values: 'id', 'title' and the various timestamp fields (default 'createdAt')
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"A non negative value to offset the start the list by (default is 0)
\n","type":"text/plain"},"key":"offset","value":"integer"},{"description":{"content":"A non negative value to limit the number of results to
\n","type":"text/plain"},"key":"limit","value":"integer"},{"description":{"content":"A boolean inducating whether the result set should be ordered from top to bottom (default is false)
\n","type":"text/plain"},"key":"descending ","value":"boolean"}],"variable":[{"type":"any","value":"","key":"beneficiaryId"}]}},"response":[],"_postman_id":"ed2d8caa-f8a3-44ee-91c6-97e1952fda3c"}],"id":"1f458c64-7145-4427-a752-ce303cbbf9dc","description":"The Lease ID
\n","type":"text/plain"},"type":"string","value":"","key":"leaseId"}]}},"response":[{"id":"b43cded3-fa59-4d26-b333-9de2b54a4f51","name":"Get lease","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId"],"variable":[{"key":"leaseId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1","type":"string","description":"The Lease ID"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e78cfa5f-a48a-4f8e-b7d4-9b3f47615d98\",\n \"referenceCode\": \"02L84T9N0\",\n \"assetId\": \"00e24028-fea8-414a-b70f-50e2f46db4cb\",\n \"unit\": \"test\",\n \"startsAt\": \"2019-09-17\",\n \"endsAt\": \"2020-09-16\",\n \"address\": {\n \"line\": \"12450b Burbank Boulevard\",\n \"city\": \"Los Angeles\",\n \"country\": \"US\",\n \"state\": \"California\",\n \"postalCode\": \"91607\"\n },\n \"rent\": 150000,\n \"security\": {\n \"deducted\": 0,\n \"graceDays\": 45,\n \"requiredAmount\": 150000,\n \"availableAmount\": 150000,\n \"status\": \"Approved\",\n \"type\": \"BillingAuthorization\"\n },\n \"autoReleaseAt\": null,\n \"metadata\": {},\n \"createdAt\": \"2019-09-10T14:09:40.484Z\",\n \"approvedAt\": \"2019-09-10T14:11:41.828Z\",\n \"terminatedAt\": null\n}\n"}],"_postman_id":"060160c9-397f-4fde-b3a8-fe77b910b847"},{"name":"List leases","id":"4c29df6e-3beb-457e-9fe0-387011a52bd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/leases","urlObject":{"path":["v0.1","leases"],"host":["{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"9a097724-37ed-4ffe-b4b2-d0d9aa58b0cf","name":"List first 10 leases","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{apiHost}}/v0.1/leases?offset=0&limit=10","host":["{{apiHost}}"],"path":["v0.1","leases"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"totalItems\": 78,\n\t\"items\": [...]\n}"},{"id":"9e056c4e-86b7-4c47-abb7-7a439a76942b","name":"Search for a specific lease","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{apiHost}}/v0.1/leases?search=john doe","host":["{{apiHost}}"],"path":["v0.1","leases"],"query":[{"key":"search","value":"john doe"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"totalItems\": 6,\n\t\"items\": [...]\n}"}],"_postman_id":"4c29df6e-3beb-457e-9fe0-387011a52bd0"},{"name":"Create lease","id":"a59d0e7e-d18a-4da6-bc85-63c2cb401c5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/leases","urlObject":{"path":["v0.1","leases"],"host":["{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"5fd8457d-3f65-4a6b-8e19-13e851cb1fea","name":"Create lease with sub-resources","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"assetId","value":"00e24028-fea8-414a-b70f-50e2f46db4cb","type":"text"},{"key":"unit","value":"11B","type":"text"},{"key":"sendInvitation","value":"false","type":"text"},{"key":"security[requiredAmount]","value":"190000","type":"text"},{"key":"rent","value":"150000","type":"text"},{"key":"startsAt","value":"2019-12-11","type":"text"},{"key":"endsAt","value":"2020-12-10","type":"text"},{"key":"tenants[0][email]","value":"c103gKsGs5F7@myobligo.com","type":"text"},{"key":"tenants[0][firstName]","value":"Fake","type":"text"},{"key":"tenants[0][lastName]","value":"Fakeson","type":"text"},{"key":"tenants[0][phoneNumber]","value":"+12122222222","type":"text"},{"key":"tenants[0][leadTenant]","value":"true","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"{{apiHost}}/v0.1/leases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3a36a185-d0e8-4718-9f4a-0bca944724c1\"\n}\n"}],"_postman_id":"a59d0e7e-d18a-4da6-bc85-63c2cb401c5b"},{"name":"Terminate lease","id":"2af6a839-bb12-4ceb-b783-8335d76f69bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{apiHost}}/v0.1/leases/:leaseId/terminate","urlObject":{"path":["v0.1","leases",":leaseId","terminate"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The lease ID
\n","type":"text/plain"},"type":"string","value":"","key":"leaseId"}]}},"response":[{"id":"6a79d116-0ba8-4eb9-ba92-5a8e3769e47f","name":"Terminate lease","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId/terminate","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId","terminate"],"variable":[{"key":"leaseId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1","type":"string","description":"The lease ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"2af6a839-bb12-4ceb-b783-8335d76f69bc"},{"name":"Update lease","id":"9e0ebefb-ec7d-453a-8334-ff17eee1840b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/leases/:leaseId","urlObject":{"path":["v0.1","leases",":leaseId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The Lease ID
\n","type":"text/plain"},"type":"string","value":"","key":"leaseId"}]}},"response":[{"id":"da944832-c31d-4a5c-a49c-85bfbfc4683d","name":"Update lease unit and lease end date","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"endsAt","value":"2021-02-24","type":"text"},{"key":"unit","value":"15C","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId"],"variable":[{"key":"leaseId","value":"e78cfa5f-a48a-4f8e-b7d4-9b3f47615d98","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"updated\": true\n}"}],"_postman_id":"9e0ebefb-ec7d-453a-8334-ff17eee1840b"}],"id":"d5addb2c-86fd-446f-aed1-e444411e2ee2","description":"Leases are the most important resources in the Obligo API.
\nA lease object may represent a lease with a tenant that’s already been approved by the landlord and needs to pay their security deposit and/or move-in payments, or an application for a new tenant.\n
\nThere are two components to the leases API:
Draft - Not all required fields have been provided on the lease.
\nPending - Pending the tenant's action. At this point - the lead tenant should be sent to their invitation link.
\nPendingConfirmation - The tenant has initiated a payment, and it has not been approved yet.
\nApproved - Obligo has approved that this tenant has provided the required security.
\nCanceled - The lease was terminated prior to Obligo approving the security component.
\nReleased - The lease was terminated after Obligo approved the security component.\n
In order to promote the security status from 'Draft' to 'Pending', the following data must be provided on the lease, in any order that suits your flow:
\nIn order to understand the lease flow, please review the following diagram:
\n
leaseId will be included in the response when getting a tenant.
The tenant ID
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"0e13f46b-c29a-4a49-8423-39b24cecae44","name":"Get tenant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/tenants/:tenantId","host":["{{apiHost}}"],"path":["v0.1","tenants",":tenantId"],"variable":[{"key":"tenantId","value":"","description":"The tenant ID"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"770dd0ce-f977-4e57-a334-29e24e8f96b0\",\n\t\"leaseId\": \"e78cfa5f-a48a-4f8e-b7d4-9b3f47615d98\",\n \"leadTenant\": true,\n \"firstName\": \"Fake\",\n \"lastName\": \"Fakeson\",\n \"email\": \"09yiugfghv@myobligo.com\",\n \"phoneNumber\": \"+12122222222\",\n \"invitationUrl\": \"https://tenants.myobligo.com/invitation/BMff2Z5htX9hExUfs3s\",\n \"consents\": [\"BackgroundCheck\"],\n \"dateOfBirth\": \"1993-06-17\",\n \"lastAddress\": {\n\t \"line\" : \"Mock Lane\",\n\t \"city\" : \"Orangeburg\",\n\t \"state\" : \"South Carolina\",\n\t\t\"country\" : \"US\",\n\t \"postalCode\" : \"29118\"\n },\n \"ssnLastFour\": \"6789\",\n \"metadata\": {},\n \"invitationLastSentAt\": \"2019-09-09T12:08:12.441Z\",\n \"invitationLastOpenedAt\": \"2019-09-10T14:10:15.541Z\"\n}"}],"_postman_id":"dfc02736-9426-485a-b14e-a7f60a3915e7"},{"name":"List tenants","id":"d7b49318-3ca5-444a-b73d-cdccac06e9e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/leases/:leaseId/tenants","urlObject":{"path":["v0.1","leases",":leaseId","tenants"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The lease ID
\n","type":"text/plain"},"type":"string","value":"","key":"leaseId"}]}},"response":[{"id":"e4d61934-9255-4b90-abaa-c93d303bf06e","name":"List all tenants for a specific lease","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId/tenants","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId","tenants"],"variable":[{"key":"leaseId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1","type":"string"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"totalItems\": 1,\n\t\"items\": [...]\n}"}],"_postman_id":"d7b49318-3ca5-444a-b73d-cdccac06e9e2"},{"name":"Create tenant","id":"3919132b-f070-4391-8a69-3553fde643e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{apiHost}}/v0.1/leases/:leaseId/tenants","urlObject":{"path":["v0.1","leases",":leaseId","tenants"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The lease ID
\n","type":"text/plain"},"type":"string","value":"","key":"leaseId"}]}},"response":[{"id":"bbc978fc-97d8-4f59-abee-08fb3c46428f","name":"Create tenant","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","value":"Fake","type":"text"},{"key":"lastName","value":"Fakeson","type":"text"},{"key":"email","value":"fake_fakeson11@myobligo.com","type":"text"},{"key":"leadTenant","value":"true","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId/tenants","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId","tenants"],"variable":[{"key":"leaseId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1","type":"string","description":"The tenant ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\tid: \"770dd0ce-f977-4e57-a334-29e24e8f96b0\"\n}"}],"_postman_id":"3919132b-f070-4391-8a69-3553fde643e4"},{"name":"Update tenant","id":"bffd57d2-4e57-43da-85b5-ea3927f8aecb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/tenants/:tenantId","description":"Note that in order to update tenant consents, a timestamp and tenant ip address must be provided with the request.
\nSee 'Update tenant consent' example request for more details.
The tenant ID
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"846fce5b-5b4f-42d0-b7a9-f048a02c5bfc","name":"Update tenant consent","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"consent[types]","value":"[\"BackgroundCheck\", \"CreditReport\"]","type":"text"},{"key":"consent[timestamp]","value":"2019-12-31T18:22:20.000Z","type":"text"},{"key":"consent[ipAddress]","value":"78.157.67.148","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/tenants/:tenantId","host":["{{apiHost}}"],"path":["v0.1","tenants",":tenantId"],"variable":[{"key":"tenantId","value":"","type":"string","description":"The tenant ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"8dd78c9f-1faf-4933-bb9d-0998b7acec00","name":"Update tenant first and last name","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","value":"Real","type":"text"},{"key":"lastName","value":"Realson","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/tenants/:tenantId","host":["{{apiHost}}"],"path":["v0.1","tenants",":tenantId"],"variable":[{"key":"tenantId","value":"","type":"string","description":"The Lease ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"bffd57d2-4e57-43da-85b5-ea3927f8aecb"},{"name":"Delete tenant","id":"dd912c00-0673-4911-a5b7-78473f53dc77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/tenants/:tenantId","urlObject":{"path":["v0.1","tenants",":tenantId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The tenant ID
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"75fbd960-6891-45bb-b3a3-0dbb5bbf6438","name":"Delete tenant","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/tenants/:tenantId","host":["{{apiHost}}"],"path":["v0.1","tenants",":tenantId"],"variable":[{"key":"tenantId","value":"cdc024ed-2de1-44df-9965-1adf22c067c4","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"dd912c00-0673-4911-a5b7-78473f53dc77"},{"name":"Send invitation email to tenant","id":"9fbeaf3f-981f-4fe7-becf-d524f595f12e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/tenants/:tenantId/send-invitation","description":"Sending and invitation email to the tenant is only possible when the security status is Pending
The ID of the tenant for who will be accessing the Obligo embedded experience
\n","key":"tenantId","type":"text","value":"uuid (required)"}]},"url":"{{apiHost}}/v0.1/leases/:leaseId/user-sessions","urlObject":{"path":["v0.1","leases",":leaseId","user-sessions"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The lease id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"leaseId"}]}},"response":[],"_postman_id":"7aa841ba-dd39-4814-98ae-ce0077a00002"}],"id":"f59aaba0-a7da-4a5c-a691-9d0d78bd1b17","description":"Tenants are a subresource of a lease.
\nEach lease must have a lead tenant, who is responsible for completing the onboarding flow in the Obligo platform.
\nThere can only be one lead tenant per lease.\n
The risk analysis ID
\n","type":"text/plain"},"type":"string","value":"","key":"riskAnalysisId"}]}},"response":[{"id":"6ec255c0-f981-4591-a5bb-7087230f5a94","name":"Get risk analysis with Criminal records check","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/risk-analyses/:riskAnalysisId","host":["{{apiHost}}"],"path":["v0.1","risk-analyses",":riskAnalysisId"],"variable":[{"key":"riskAnalysisId","value":"07ffdcf0-a228-4d47-8b5f-e0fca7a25b8d","type":"string","description":"The risk analysis ID"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"07ffdcf0-a228-4d47-8b5f-e0fca7a25b8d\",\n \"tenantId\": \"651fb640-283a-47cd-9d92-f84688ac1280\",\n \"status\": \"Completed\",\n \"failureReason\": null,\n \"reports\": [\n {\n \"type\": \"CreditReport\",\n \"status\": \"Completed\",\n \"result\": {\n \"matchFound\": true,\n \"score\": 660,\n \"flags\": {\n \"red\": [\n \"Report shows a high percentage of credit used.\"\n ],\n \"green\": []\n },\n \"publicRecords\": {\n \"bankruptcies\": \"Warning\",\n \"collections\": \"Cleared\",\n \"legalItems\": \"Cleared\"\n },\n \"debt\": {\n \"totalDebt\": 0,\n \"revolvingCredit\": {\n \"totalBalance\": \"365.00\",\n \"maxTotalLimit\": \"0.00\",\n \"percentCreditUsed\": null,\n \"numberOfCards\": 1,\n \"pastDueAmount\": \"0.00\",\n \"latePayments30\": 0,\n \"latePayments60\": 0,\n \"latePayments90\": 0,\n \"monthlyPayments\": \"10.00\"\n },\n \"otherCredit\": {\n \"totalBalance\": null,\n \"maxTotalLimit\": null,\n \"percentCreditUsed\": null,\n \"numberOfCards\": null,\n \"pastDueAmount\": null,\n \"latePayments30\": null,\n \"latePayments60\": null,\n \"latePayments90\": null,\n \"monthlyPayments\": null\n },\n \"mortgageLoans\": {\n \"totalBalance\": null,\n \"maxTotalLimit\": null,\n \"percentCreditUsed\": null,\n \"numberOfMortgages\": null,\n \"pastDueAmount\": null,\n \"latePayments30\": null,\n \"latePayments60\": null,\n \"latePayments90\": null,\n \"monthlyPayments\": null\n },\n \"autoLoans\": {\n \"totalBalance\": null,\n \"maxTotalLimit\": null,\n \"percentCreditUsed\": null,\n \"numberOfLoans\": null,\n \"pastDueAmount\": null,\n \"latePayments30\": null,\n \"latePayments60\": null,\n \"latePayments90\": null,\n \"monthlyPayments\": null\n },\n \"studentLoans\": {\n \"totalBalance\": null,\n \"maxTotalLimit\": null,\n \"percentCreditUsed\": null,\n \"numberOfLoans\": null,\n \"pastDueAmount\": null,\n \"latePayments30\": null,\n \"latePayments60\": null,\n \"latePayments90\": null,\n \"monthlyPayments\": null\n },\n \"otherDebts\": {\n \"totalBalance\": null,\n \"maxTotalLimit\": null,\n \"percentCreditUsed\": null,\n \"numberOfDebts\": null,\n \"pastDueAmount\": null,\n \"latePayments30\": null,\n \"latePayments60\": null,\n \"latePayments90\": null,\n \"monthlyPayments\": null\n }\n }\n }\n },\n {\n \"type\": \"CriminalRecordsCheck\",\n \"status\": \"Completed\",\n \"result\": {\n \"score\": \"Warning\",\n \"certnScore\": \"30.40\",\n \"flags\": {\n \"red\": [\n \"Alerts discovered.\"\n ],\n \"green\": []\n },\n \"sources\": [\n {\n \"type\": \"Criminal Court Database Record Check\",\n \"state\": \"OH\",\n \"status\": \"Complete\"\n }\n ],\n \"ssnVerification\": [\n {\n \"result\": \"NoDiscrepancy\",\n \"status\": \"OHIO In 1979-1981\"\n }\n ],\n \"criminalCases\": [\n [\n {\n \"description\": \"Breach/Breach Of Peace, Nonaggravated\",\n \"type\": \"Felony\",\n \"dispositions\": [\n {\n \"offenseDescription\": \"Excessive Speeding 064/55\",\n \"offenseType\": \"Citation\",\n \"description\": \"Not Responsible\",\n \"date\": \"1997-03-06\"\n },\n {\n \"offenseDescription\": \"Speeding 064/55\",\n \"offenseType\": \"Infraction\",\n \"description\": \"Responsible\",\n \"date\": \"1995-03-06\"\n }\n ],\n \"arrests\": [\n {\n \"offenseDescription\": \"Breach/Breach Of Peace, Highly Aggravated\",\n \"offenseType\": \"Felony\",\n \"date\": \"2016-02-12\"\n },\n {\n \"offenseDescription\": \"Breach/Breach Of Peace, Nonaggravated\",\n \"offenseType\": \"Misdemeanor\",\n \"date\": \"2013-02-12\"\n }\n ],\n \"sentences\": [\n {\n \"type\": \"Fine\",\n \"duration\": null,\n \"amount\": \"25.00\",\n \"effectiveDate\": \"2000-12-12\"\n },\n {\n \"type\": \"Costs\",\n \"duration\": \"1 Day\",\n \"amount\": \"60.00\",\n \"effectiveDate\": null\n }\n ]\n }\n ]\n ]\n }\n }\n ]\n}"},{"id":"fa08dc52-67d3-4a63-bff4-93ff5809a31d","name":"Get risk analysis","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":{"raw":"{{apiHost}}/v0.1/risk-analyses/:riskAnalysisId","host":["{{apiHost}}"],"path":["v0.1","risk-analyses",":riskAnalysisId"],"variable":[{"key":"riskAnalysisId","value":"07ffdcf0-a228-4d47-8b5f-e0fca7a25b8c"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"07ffdcf0-a228-4d47-8b5f-e0fca7a25b8c\",\n\t\"tenantId\": \"651fb640-283a-47cd-9d92-f84688ac1280\",\n\t\"status\": \"Completed\",\n\t\"failureReason\": null,\n\t\"reports\": [\n\t\t{\n\t\t\t\"type\": \"CreditReport\",\n \"status\": \"Completed\",\n\t\t\t\"result\": {\n\t\t\t\t\"matchFound\": true,\n\t\t\t\t\"score\": 660,\n\t\t\t\t\"flags\": {\n\t\t \"red\": [\n\t\t \"Report shows a high percentage of credit used.\"\n\t\t ],\n\t\t \"green\": []\n\t \t},\n\t\t\t\t\"publicRecords\": {\n\t\t\t\t\t\"bankruptcies\": \"Warning\",\n \t\t\t\t\"collections\": \"Cleared\",\n \t\t\t\t\"legalItems\": \"Cleared\"\n\t\t\t\t},\n\t\t\t\t \"debt\" : {\n \"totalDebt\" : 0,\n \"revolvingCredit\" : {\n \"totalBalance\" : \"365.00\",\n \"maxTotalLimit\" : \"0.00\",\n \"percentCreditUsed\" : null,\n \"numberOfCards\" : 1,\n \"pastDueAmount\" : \"0.00\",\n \"latePayments30\" : 0,\n \"latePayments60\" : 0,\n \"latePayments90\" : 0,\n \"monthlyPayments\" : \"10.00\"\n },\n \"otherCredit\" : {\n \"totalBalance\" : null,\n \"maxTotalLimit\" : null,\n \"percentCreditUsed\" : null,\n \"numberOfCards\" : null,\n \"pastDueAmount\" : null,\n \"latePayments30\" : null,\n \"latePayments60\" : null,\n \"latePayments90\" : null,\n \"monthlyPayments\" : null\n },\n \"mortgageLoans\" : {\n \"totalBalance\" : null,\n \"maxTotalLimit\" : null,\n \"percentCreditUsed\" : null,\n \"numberOfMortgages\" : null,\n \"pastDueAmount\" : null,\n \"latePayments30\" : null,\n \"latePayments60\" : null,\n \"latePayments90\" : null,\n \"monthlyPayments\" : null\n },\n \"autoLoans\" : {\n \"totalBalance\" : null,\n \"maxTotalLimit\" : null,\n \"percentCreditUsed\" : null,\n \"numberOfLoans\" : null,\n \"pastDueAmount\" : null,\n \"latePayments30\" : null,\n \"latePayments60\" : null,\n \"latePayments90\" : null,\n \"monthlyPayments\" : null\n },\n \"studentLoans\" : {\n \"totalBalance\" : null,\n \"maxTotalLimit\" : null,\n \"percentCreditUsed\" : null,\n \"numberOfLoans\" : null,\n \"pastDueAmount\" : null,\n \"latePayments30\" : null,\n \"latePayments60\" : null,\n \"latePayments90\" : null,\n \"monthlyPayments\" : null\n },\n \"otherDebts\" : {\n \"totalBalance\" : null,\n \"maxTotalLimit\" : null,\n \"percentCreditUsed\" : null,\n \"numberOfDebts\" : null,\n \"pastDueAmount\" : null,\n \"latePayments30\" : null,\n \"latePayments60\" : null,\n \"latePayments90\" : null,\n \"monthlyPayments\" : null\n }\n }\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"BackgroundCheck\",\n \"status\": \"Completed\",\n\t\t\t\"result\": {\n\t\t\t\t\"score\" : \"Pass\",\n\t\t\t\t\"certnScore\" : \"77.60\",\n\t\t\t\t\"flags\" : {\n\t\t\t \"red\" : [],\n\t\t\t \"green\" : [\n\t\t\t \t\"No alerts found.\"\n\t\t\t ]\n\t\t\t },\n\t\t\t \"criminal\": \"Cleared\",\n\t\t\t \"fraud\": \"Cleared\",\n\t\t\t \"sexOffender\": \"Cleared\",\n\t\t\t \"knownAffiliations\": \"Cleared\"\n\t\t\t}\n\t\t}\n\t]\n}"}],"_postman_id":"2975b5c0-147e-4568-ba16-823b6f478a31"},{"name":"List risk analyses","id":"45adffb1-4383-4cad-9342-b272d5e6f438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/tenants/:tenantId/risk-analyses","urlObject":{"path":["v0.1","tenants",":tenantId","risk-analyses"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The tenant ID
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"e66c9744-adb3-45ff-8fa5-802aabca9ee0","name":"List risk last 3 analyses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/tenants/:tenantId/risk-analyses?offset=0&limit=3","host":["{{apiHost}}"],"path":["v0.1","tenants",":tenantId","risk-analyses"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"3"}],"variable":[{"key":"tenantId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"totalItems\": 3,\n\t\"items\": [...]\n}"}],"_postman_id":"45adffb1-4383-4cad-9342-b272d5e6f438"},{"name":"Create risk analysis","id":"1f69b4f6-d66b-44f1-bd7b-c5e55a99112b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/tenants/:tenantId/risk-analyses","urlObject":{"path":["v0.1","tenants",":tenantId","risk-analyses"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The tenant ID
\n","type":"text/plain"},"type":"string","value":"","key":"tenantId"}]}},"response":[{"id":"99a28d20-1195-4838-8023-07e56057bb40","name":"Create risk analysis with a credit report and a background check","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"reports","value":"['CreditReport', 'BackgroundCheck']","type":"text"}]},"url":{"raw":"{{apiHost}}/v0.1/tenants/:tenantId/risk-reports","host":["{{apiHost}}"],"path":["v0.1","tenants",":tenantId","risk-reports"],"variable":[{"key":"tenantId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"id\": \"UUID\"\n}"}],"_postman_id":"1f69b4f6-d66b-44f1-bd7b-c5e55a99112b"},{"name":"Delete risk analysis","id":"b32f4fc4-7736-463c-85c4-a455bd918e81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/risk-analyses/:riskAnalysesId","urlObject":{"path":["v0.1","risk-analyses",":riskAnalysesId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The risk analysis ID
\n","type":"text/plain"},"type":"string","value":"","key":"riskAnalysesId"}]}},"response":[{"id":"0c841966-4ac4-4937-8825-28f8419e5d18","name":"Delete risk analysis","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/risk-analyses/:riskAnalysesId","host":["{{apiHost}}"],"path":["v0.1","risk-analyses",":riskAnalysesId"],"variable":[{"key":"riskAnalysesId","value":"07ffdcf0-a228-4d47-8b5f-e0fca7a25b8c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"b32f4fc4-7736-463c-85c4-a455bd918e81"},{"name":"Export risk analysis pdf","id":"4e58c055-b85d-453a-9476-4fcd81dbbdb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":"{{apiHost}}/v0.1/risk-analyses/:riskAnalysisId/pdf","description":"Exporting the pdf is only possible if the risk analysis status is PartiallyCompleted or Completed.
The risk analysis ID
\n","type":"text/plain"},"type":"string","value":"","key":"riskAnalysisId"}]}},"response":[{"id":"1dfacf7e-a34e-4106-8723-1282a95bde59","name":"Export risk analysis pdf","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/risk-analyses/:riskAnalysisId/pdf","host":["{{apiHost}}"],"path":["v0.1","risk-analyses",":riskAnalysisId","pdf"],"variable":[{"key":"riskAnalysisId","value":"9b63e90c-d5cb-4e80-bc4f-04807f8d030d"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/pdf","description":"","type":"text"},{"key":"Content-Disposition","value":"attachment; filename=TenantFirstName_TenantLastName-9b63e90c-d5cb-4e80-bc4f-04807f8d030d.pdf","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4e58c055-b85d-453a-9476-4fcd81dbbdb7"}],"id":"0741f261-0785-4dcc-830a-11014adc1404","description":"Risk analyses allow API users to get different reports and risk metrices on a certain applicant. \n
\nImportant Note - BackgroundCheck report is being depracted and will soon be unavailable. It is recommended to use CriminalRecordsCheck instead.\n
In order to successfully run a risk analysis on a tenant, you will need to provide the following details through the tenant api:
\nCreditReport or BackgroundCheck and required for CriminalRecordsCheck. When optional, providing the ssn reduces the chances of a mismatch greatly. The ssn is encrypted when saved and only the last four digits are shown on the resource.InProgress - Risk analysis is currently running.
\nPartiallyCompleted - Risk analysis has not completed yet, but some of the requested reports and is still running others.
\nCompleted - Risk analysis is completed and the tenant report results are available.
\nFailed - Risk analysis failed to run. A description for the error can be found in the failureReason field.
Failure
\nIn order to simulate a scenario where the risk analysis fails to run, set the tenant date of birth to '1777-07-07'.
\nThis will cause the risk analysis to return with a 'Failed' status.
No Match
\nCreditReport reports may return a no match found result in cases where no information related to the tenant is found or the tenant's credit has been frozen.
\nIn order to simulate a scenario where a CreditReport report results in a no match found, set the tenant date of birth to '1444-04-04' and request a risk analysis with a single report of type CreditReport.
\nThis will cause the risk analysis to return a 'no match found' result ({matchFound: false}) for the CreditReport.
The payment type ID associated with this item
\n","type":"text"},{"key":"lineItems[0][amount]","value":"integer (required)","description":"A non negative integer representing the price of this item in cents
\n","type":"text"},{"key":"lineItems[0][description]","value":"string","description":"A short human readable string describing the line item
\n","type":"text"},{"key":"context","value":"string (required)","description":"The context of the invoice in the lease lifecycle
\n","type":"default"}]},"url":"{{apiHost}}/v0.1/leases/:leaseId/invoices","urlObject":{"path":["v0.1","leases",":leaseId","invoices"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The lease ID
\n","type":"text/plain"},"type":"string","value":"uuid","key":"leaseId"}]}},"response":[{"id":"47a51e67-90c6-42a7-8e96-03736151d643","name":"Create invoice","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"context\": \"Application\",\n \"lineItems\": [\n {\n \"typeId\": \"10158f07-6692-442f-9842-ede57b22706e\",\n \"amount\": 124300\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId/invoices","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId","invoices"],"variable":[{"key":"leaseId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1ece45bc-1377-4b83-b858-bd4e353723e6\"\n}"}],"_postman_id":"cee4321d-a454-4113-bffd-0fe73c2ff685"},{"name":"Get invoice","id":"bdf98b1e-3c18-48ea-ad87-e028ddeaa675","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/invoices/:invoiceId","urlObject":{"path":["v0.1","invoices",":invoiceId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"}]}},"response":[{"id":"9b5f538b-c4e8-40a9-ba1e-1073865e8f2f","name":"Get invoice","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/invoices/:invoiceId","host":["{{apiHost}}"],"path":["v0.1","invoices",":invoiceId"],"variable":[{"key":"invoiceId","value":"1ece45bc-1377-4b83-b858-bd4e353723e6"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"1ece45bc-1377-4b83-b858-bd4e353723e6\",\r\n \"status\": \"Ready\",\r\n \"context\": \"Application\",\r\n \"lineItems\": [\r\n {\r\n \"id\": \"4cb53f64-f97d-4795-8b5e-f32f98f5f909\",\r\n \"typeId\": \"10158f07-6692-442f-9842-ede57b22706e\",\r\n \"amount\": 124300,\r\n \"description\": null,\r\n \"tagIds\": []\r\n }\r\n ],\r\n \"balance\": {\r\n \"debit\": {\r\n \"open\": 1000,\r\n \"processing\": 0,\r\n \"processed\": 123300\r\n },\r\n \"credit\": {\r\n \"available\": 123300,\r\n \"processing\": 0,\r\n \"processed\": 0\r\n },\r\n \"refund\": {\r\n \"pending\": 0,\r\n \"processing\": 0,\r\n \"processed\": 0\r\n }\r\n },\r\n\r\n \"createdAt\": \"2020-05-13T12:37:58.000Z\",\r\n \"updatedAt\": \"2020-05-13T12:37:59.000Z\",\r\n \"finalizedAt\": \"2020-05-13T12:37:59.000Z\",\r\n \"canceledAt\": \"2020-05-13T12:37:59.000Z\",\r\n \"setteledAt\": \"2020-05-13T12:37:59.000Z\"\r\n}"}],"_postman_id":"bdf98b1e-3c18-48ea-ad87-e028ddeaa675"},{"name":"Update invoice line item","id":"4fabf135-dcec-4c13-b32f-6956f08caf67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"amount","value":"integer","description":"A non negative integer representing the price of this item in cents
\n","type":"text"},{"key":"description","value":"string","description":"A short human readable string describing the line item
\n","type":"text"},{"key":"tagIds","value":"array of strings","description":"A list of tags that are related to this line item
\n","type":"default"}]},"url":"{{apiHost}}/v0.1/invoices/:invoiceId/line-items/:lineItemId","urlObject":{"path":["v0.1","invoices",":invoiceId","line-items",":lineItemId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"},{"description":{"content":"The line item ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"lineItemId"}]}},"response":[{"id":"a412b310-3cd6-43a0-8983-c3a40e9efb37","name":"Update an invoice line item","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 80000,\n \"description\": \"Application fee for Jerry and Elaine\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{apiHost}}/v0.1/invoices/:invoiceId/line-items/:lineItemId","host":["{{apiHost}}"],"path":["v0.1","invoices",":invoiceId","line-items",":lineItemId"],"variable":[{"key":"invoiceId","value":"1ece45bc-1377-4b83-b858-bd4e353723e6"},{"key":"lineItemId","value":"8c373e25-ffd3-490a-95a2-3efcbefcfe99"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"407315a3-38d5-4733-b78d-5c493847f5de","name":"Update an invoice line item tags","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tagIds\": [\"62818e58-426b-4cdc-b5c2-d3b05dceecdf\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{apiHost}}/v0.1/invoices/:invoiceId/line-items/:lineItemId","host":["{{apiHost}}"],"path":["v0.1","invoices",":invoiceId","line-items",":lineItemId"],"variable":[{"key":"invoiceId","value":"1ece45bc-1377-4b83-b858-bd4e353723e6"},{"key":"lineItemId","value":"8c373e25-ffd3-490a-95a2-3efcbefcfe99"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"4fabf135-dcec-4c13-b32f-6956f08caf67"},{"name":"Update invoice","id":"51e1af86-2683-4219-b1b9-83e1705d31d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","type":"text","value":"Basic {{apiKey}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Custom key-value store
\n","key":"metadata","type":"text","value":"object"}]},"url":"{{apiHost}}/v0.1/invoices/:invoiceId","urlObject":{"path":["v0.1","invoices",":invoiceId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"}]}},"response":[{"id":"13f798cb-8c65-4ed7-bc3a-ed6b4a9d705c","name":"Update an invoice","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"metadata\": {\n \"correlationId\": \"0beaf1c0-3fea-4d09-99a8-4ab25dc436c2\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{apiHost}}/v0.1/invoices/:invoiceId","host":["{{apiHost}}"],"path":["v0.1","invoices",":invoiceId"],"variable":[{"key":"invoiceId","value":"1ece45bc-1377-4b83-b858-bd4e353723e6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"51e1af86-2683-4219-b1b9-83e1705d31d4"},{"name":"Add invoice line item","id":"2124627e-6811-4d05-ba8f-403da878a6d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"typeId","value":"uuid (required)","description":"The payment type ID associated with this item
\n","type":"text"},{"key":"amount","value":"integer (required)","description":"A non negative integer representing the price of this item in cents
\n","type":"text"},{"key":"description","value":"string","description":"A short human readable string describing the line item
\n","type":"text"}]},"url":"{{apiHost}}/v0.1/invoices/:invoiceId/line-items","urlObject":{"path":["v0.1","invoices",":invoiceId","line-items"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"}]}},"response":[{"id":"cdd3a425-658e-40a7-8d92-354cbdadef24","name":"Add an invoice line item","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"typeId\": \"ae4a5e57-ea26-41e2-ba53-ca09b645fd48\",\n \"amount\": 50000,\n \"description\": \"Application fee for Jerry and George\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{apiHost}}/v0.1/invoices/:invoiceId/line-items","host":["{{apiHost}}"],"path":["v0.1","invoices",":invoiceId","line-items"],"variable":[{"key":"invoiceId","value":"1ece45bc-1377-4b83-b858-bd4e353723e6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"8c373e25-ffd3-490a-95a2-3efcbefcfe99\"\n}"}],"_postman_id":"2124627e-6811-4d05-ba8f-403da878a6d5"},{"name":"Cancel invoice","id":"b316844d-5ba7-4cb1-81d6-ae186274f424","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/invoices/:invoiceId/cancel","urlObject":{"path":["v0.1","invoices",":invoiceId","cancel"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uid","key":"invoiceId"}]}},"response":[],"_postman_id":"b316844d-5ba7-4cb1-81d6-ae186274f424"},{"name":"Finalize invoice","id":"fc014f5e-59c9-4eac-9385-32f1db9f9f74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{apiHost}}/v0.1/invoices/:invoiceId/finalize","urlObject":{"path":["v0.1","invoices",":invoiceId","finalize"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"}]}},"response":[],"_postman_id":"fc014f5e-59c9-4eac-9385-32f1db9f9f74"},{"name":"Delete invoice","id":"5656a1bf-696b-4f0e-861d-cd28d14e0f69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"url":"{{apiHost}}/v0.1/invoices/:invoiceId","urlObject":{"path":["v0.1","invoices",":invoiceId"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice ID
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"}]}},"response":[],"_postman_id":"5656a1bf-696b-4f0e-861d-cd28d14e0f69"},{"name":"List invoices","id":"9bba14ed-509c-486a-8ea3-2d6011bf33be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"url":"{{apiHost}}/v0.1/leases/:leaseId/invoices?sortBy=string&offset=integer&limit=integer&descending=boolean","urlObject":{"path":["v0.1","leases",":leaseId","invoices"],"host":["{{apiHost}}"],"query":[{"description":{"content":"Supported values: 'id', 'status' and the various timestamp fields (default 'createdAt')
\n","type":"text/plain"},"key":"sortBy","value":"string"},{"description":{"content":"A non negative value to offset the start the list by (default is 0)
\n","type":"text/plain"},"key":"offset","value":"integer"},{"description":{"content":"A non negative value to limit the number of results to (default is 10)
\n","type":"text/plain"},"key":"limit","value":"integer"},{"description":{"content":"A boolean inducating whether the result set should be ordered from top to bottom (default is false)
\n","type":"text/plain"},"key":"descending","value":"boolean"}],"variable":[{"description":{"content":"The lease ID
\n","type":"text/plain"},"type":"string","value":"","key":"leaseId"}]}},"response":[{"id":"fc572b9d-71e2-4549-9d1d-32a984584b42","name":"List all invoices for a specific lease","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{apiKey}}","type":"text"}],"url":{"raw":"{{apiHost}}/v0.1/leases/:leaseId/invoices?limit=1","host":["{{apiHost}}"],"path":["v0.1","leases",":leaseId","invoices"],"query":[{"key":"limit","value":"1"}],"variable":[{"key":"leaseId","value":"3a36a185-d0e8-4718-9f4a-0bca944724c1","type":"string"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"totalItems\": 6,\n \"items\": [\n {\n \"id\": \"1ece45bc-1377-4b83-b858-bd4e353723e6\",\n \"status\": \"Ready\",\n \"context\": \"Application\",\n \"lineItems\": [\n {\n \"id\": \"4cb53f64-f97d-4795-8b5e-f32f98f5f909\",\n \"typeId\": \"10158f07-6692-442f-9842-ede57b22706e\",\n \"amount\": 124300,\n \"description\": null\n },\n {\n \"id\": \"8c373e25-ffd3-490a-95a2-3efcbefcfe99\",\n \"typeId\": \"ae4a5e57-ea26-41e2-ba53-ca09b645fd48\",\n \"amount\": 80000,\n \"description\": \"Application fee for Jerry and Elaine\"\n }\n }\n ],\n \"balance\": {\n \"debit\": {\n \"open\": 1000,\n \"processing\": 0,\n \"processed\": 123300\n },\n \"credit\": {\n \"available\": 123300,\n \"processing\": 0,\n \"processed\": 0\n },\n \"refund\": {\n \"pending\": 0,\n \"processing\": 0,\n \"processed\": 0\n }\n },\n \"createdAt\": \"2020-05-13T12:37:58.000Z\",\n \"updatedAt\": \"2020-05-13T12:37:59.000Z\",\n \"finalizedAt\": \"2020-05-13T12:37:59.000Z\",\n \"canceledAt\": \"2020-05-13T12:37:59.000Z\",\n \"setteledAt\": \"2020-05-13T12:37:59.000Z\"\n }\n ...\n ]\n}"}],"_postman_id":"9bba14ed-509c-486a-8ea3-2d6011bf33be"},{"name":"Create payment session","id":"e47ac5b9-519c-4b6a-ba6b-adb5e6b584d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"},{"key":"Authorization","type":"text","value":"Basic {{apiKey}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"The ID of the tenant for which the payment session is created
\n","key":"tenantId","type":"text","value":"uuid (required)"}]},"url":"{{apiHost}}/v0.1/invoices/:invoiceId/payment-sessions","urlObject":{"path":["v0.1","invoices",":invoiceId","payment-sessions"],"host":["{{apiHost}}"],"query":[],"variable":[{"description":{"content":"The invoice id
\n","type":"text/plain"},"type":"any","value":"uuid","key":"invoiceId"}]}},"response":[],"_postman_id":"e47ac5b9-519c-4b6a-ba6b-adb5e6b584d1"}],"id":"5a830afb-a44d-4c2a-878a-66841aa1f3dd","description":"Ready - Waiting for the invoice debit to be fully processed or waiting for the invoice to be finalized/canceled
Canceled - The invoice was canceled
Finalized - Invoice is locked for changes and credit and refund processes were initiated
Settled - The credit and refund processes were processed successfully
Application - The invoice will not be considered as part of the move-in or move-out processes.
MoveIn - The invoice will be associated with the renters' move-in process.
MoveOut - The invoice will be in the context of the renter move-out process. When the invoice is finalized, Obligo will apply any balance to their security, if applicable.
Example: Let's assume a renter provided a $2,000 Billing Authorization and a move-out invoice was created with charges for $500. When the invoice is finalized Obligo will automatically apply $500 to their authorization and close the lease account (effectively making the remaining $1,500 unchargeable)
\nWhen the lead tenant finishes the security deposit flow, either providing a cash deposit or a billing authorization, the security status on the lease resource will change to Approved.\n
\nAt that time, we will send the following webhook:
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"lease.security.approved\",\n \"data\": {\n \"leaseId\": UUID // The lease that was updated\n }\n}\nWhen an invoice created in the context of a lease is setteld (all debit, credit and refunds were processed), we will send the following webhook:
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"lease.invoice.settled\",\n \"data\": {\n \"leaseId\": UUID, // The lease identifier\n \"invoiceId\": UUID // The invoice identifier\n }\n}\nWhen the payments of an invoice created in the context of a lease are fulfilled , we will send the following webhook:
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"lease.invoice.debitProcessed\",\n \"data\": {\n \"leaseId\": UUID, // The lease identifier\n \"invoiceId\": UUID // The invoice identifier\n }\n}\n\nWhen a payment of an invoice created in the context of a lease failed, we will send the following webhook:
\n{\n \"id\": UUID, // The webhook identifier\n \"type\": \"lease.invoice.debitFailed\",\n \"data\": {\n \"leaseId\": UUID, // The lease identifier\n \"invoiceId\": UUID // The invoice identifier\n }\n}\n\nWhen the lead tenant opens their invitation on our platform we will send the following webhook:
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"tenant.invitationOpened\",\n \"data\": {\n \"tenantId\": UUID // The tenant that opened the invitation\n }\n}\nWhen you request a risk analysis on one or more tenants, it will take a couple of minutes for our backend to process that request. When we successfully fetch the requested reports we will send the following webhook:
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"tenant.riskAnalysis.ready\",\n \"data\": {\n \"tenantId\": UUID,\n \"riskAnalysisId\": UUID\n }\n}\nWhenever one or more of the reports in the risk analysis turns Completed, we will send the following webhook :
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"tenant.riskAnalysis.reportsReady\",\n \"data\": {\n \"tenantId\": UUID,\n \"riskAnalysisId\": UUID,\n \"reports\": [String] // Either CreditReport, BackgroundCheck or CriminalRecordsCheck\n }\n}\nWhen you request a risk analysis on one or more tenants, it will take a couple of minutes for our backend to process that request. If, for some reason, we fail in fetching the requested reports we will send the following webhook:
{\n \"id\": UUID, // The webhook identifier\n \"type\": \"tenant.riskAnalysis.failed\",\n \"data\": {\n \"tenantId\": UUID,\n \"riskAnalysisId\": UUID\n }\n}\nYou can receive notifications via a webhook whenever there are updates to your resources. \nThis is especially useful for events like status updates that are not triggered by a direct API request. \n
\nTo receive webhook notifications from the Obligo API you need to first set up a webhook endpoint.\nA webhook endpoint is an http(s) url that we call every time we have an update for you (and not as a result of your own request).
The Obligo API signs the webhooks it sends to your endpoint. We do so by including an HTTP header that holds the signature called Obligo-Signature.
\nThis allows you to validate that the webhooks were sent by the Obligo API, and not by another third party.
\nThe signature is generated using a hash-based message authentication code (HMAC) with SHA-256.\n
Extract the timestamp and signatures from the header
\nThe Obligo-Signature header contains a timestamp and a signature. The timestamp is prefixed by t=, and the signature is prefixed by v=.
Obligo-Signature: t=1543336288275,v=d3860150a58a642cef60baa6f621946a5c5a3b514d347576e09110d382de513e
Split the header, using the \",\" character as the separator, to get a list of elements. Then split each element, using the = character as the separator, \n to get a prefix and value pair.
\n The value for the prefix t corresponds to the timestamp, and v corresponds to the signature. You can discard all other elements.
Prepare the signedPayload string
\nYou achieve this by concatenating:
\"<timestamp>.<JSON payload (i.e., the request’s body)>\"
Determine the expected signature
\nCompute an HMAC with the SHA256 hash function. Use the webhook endpoint signing secret as the key, and use the signedPayload string as the message.
Compare signatures
\nCompare the signature in the header to the expected signature. If a signature matches, compute the difference between the current timestamp and \nthe received timestamp, then decide if the difference is within your tolerance.
The JS SDK enables you to use Obligo's different tenant applications within your own tenant flows.
\nhttps://cdn.myobligo.com/libraries/obligoSDK.min.jshttps://cdn.myobligo.com/libraries/obligoSDK.min.js<body>\n <!-- ... Your body content -->\n <!-- Load the Obligo SDK -->\n <script src='https://cdn.myobligo.com/libraries/obligoSDK.min.js' defer></script>\n</body>\nObligo.init with a configuration object containing your Obligo api clientId.Example:
\nObligo.init({clientId: 'YOUR_CLIENT_ID'})\n// Outputs: Obligo SDK successfully initiated :)\nThe Modules of the SDK are a set of high level API commands that run and manage the different embeddable Obligo applications.
\nThe modules are available as namespaces in the Obligo object.
\nObligo {\n payment: {...PaymentApplicationAPI}\n moveIn: {...MoveInApplicationAPI}\n}\nThe payment application is is a controlled payment form, allowing to tenants to submit payment for fees like an Application Fee or a Holding Deposit.
\nopen method and pass it the session token of the invoice you'd like to ask payment for.Obligo.payment.open('PAYMENT_SESSION_TOKEN')\n:heavy_exclamation_mark: The modal will close automatically on successful payment or if the payment session token is invalid.
\n// This will open the payment form inside a target element\nObligo.payment.open('PAYMENT_SESSION_TOKEN', {targetElement: document.getElementById('my-target-element')})\nclose method and, that's it.// This will close the currently open payment form\nObligo.payment.close()\ncallback inside a configuration object to the open method. The method will be called whenever the payment has reached a final state of success, error or fail// The callback function accepts 2 parameters\n// @param {'initiated' | 'success' | 'error' | 'fail'} paymentStatus\n// @param {object} data\nObligo.payment.open('PAYMENT_SESSION_TOKEN', function (paymentStatus, data) {\n // Your callback logic\n})\npaymentStatuses. This allows you to implement a simple switch case to handle the different statuses.Obligo.payment.open('PAYMENT_SESSION_TOKEN', function (paymentStatus, data) {\n const statuses = Obligo.payment.paymentStatuses;\n switch (paymentStatus): {\n case statuses.success:\n // Example success logic\n console.log('Payment Success')\n break;\n case statuses.error:\n // Example error logic\n console.log('Payment Error', data) // Error data\n break;\n case statuses.fail:\n // Example fail logic\n console.log('Payment Fail', data) // Error data\n break;\n default:\n break;\n }\n\n})\nerror or fail, and it follows a general structure:// error | fail\n{\n code: 'ERROR_CODE', // string\n message: 'ERROR_MESSAGE' // string\n name: 'ERROR_NAME' // string\n}\n[\n {\n error: 'Card Declined',\n errorCode: 'CardDeclined',\n message: 'The card you\\'ve provided was declined, please try another payment method.'\n },\n {\n error: 'Bank Account Not Found',\n errorCode: 'NoAccount',\n message: 'We could not locate a bank account with the information provided.please verify the information.'\n },\n {\n error: 'The invoice has already been processed',\n errorCode: 'InvoiceDebitAlreadyProcessed',\n message: 'The invoice you are trying to pay, has already been processed.'\n },\n {\n error: 'Session Token has expired',\n errorCode: 'SessionTokenExpired',\n message: 'The session token you are using has expired, please refresh the token and try again.'\n }\n]\nThe Movein application is a controlled flow to create a new Obligo for a given lease using a movein-session-token.\nThe application creates a UI pop up inside your page, that runs through an Obligo Movein flow, and closes after the flow is complete.
movein-session-token fro the lease, pass it to the Obligo.movein.open method.Obligo.movein.open('MOVEIN_SESSION_TOKEN')\nObligo.movein.close method to terminate the flow.Obligo.movein.close()\nThe Obligo.movein.open method accepts an optional configuration objects, with various utilities you can leverage for your own custom experience.
Obligo.movein.open('MOVEIN_SESSION_TOKEN',{targetElement: docuemnt.getElementById('my-element')})\ntargetElement: Sets a target element for the plugin to render inside off.HTMLDivElementonProgress: A callback function to call for every step progression in the Movein flow.(prevStep: string, currStep: string) => voidonComplete: A callback function to call when the Movein flow is complete() => voidonError: A callback function to call when an error has accured in the Movein flow.(error: {errorCode: string, error: string, message: string}, step?: string) => void;onAbandon: A callback function to call when the user closes the flow prior to completing it.(step?: string) => voidAs you can see, some of the callbacks above pass a step string (prevStep, currStep including), that you can access on the Obligo.movein module using the moveinSteps property.
This property exposes an object with all the steps as key:value pairs
Obligo.movein.moveinSteps;\n// Returns\n// {\n// introduction: 'introduction',\n// offer: 'offer',\n// tenantInformation: 'tenantInformation',\n// tenantVerification: 'tenantVerification',\n// depositFreeApplication: 'depositFreeApplication',\n// checkout: 'checkout',\n// success: 'success',\n// }\nUse this object to implement a switch case in your callbacks:
\nObligo.movein.open('MOVEIN_SESSION_TOKEN', {\n onAbandon: (step) => {\n const steps = Obligo.movein.moveinSteps; // use the exposed object\n switch (step): {\n case steps.offer:\n console.log('Tenant left flow on the offer step')\n break;\n default:\n console.log('Tenant closed flow')\n break;\n }\n }\n})\n