{"info":{"_postman_id":"da54570b-97c1-4256-aa0a-69bf58a8e87b","name":"Partner API","description":"

Welcome to Spotcap's Partner API. The Partner APIs in its current version allows you to send leads and users

\n

Leads vs. Users

\n

A lead is a potential client, also known as \"prospect\", who has shown interest in Spotcap's services. When you are sending a lead via the API a Spotcap client service or sales representative will get in contact with the potential new client. In case the lead is interested in becoming a Spotcap client the lead information will be used to transform a lead into a user. A user is a client who has access to the Spotcap platform. In case you want to directly start the application process for a client please use the User endpoint.

\n

Overview

\n

Partner API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.

\n

Response to every request is sent in JSON format.

\n

The request method determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something and POST implies you want to save something new.

\n

The API calls will respond with appropriate HTTP status codes for all requests.

\n

Authentication

\n

An API Key is required to be sent as part of every request to the Partner API, in the form of an X-Api-Key request header.

\n

An API Key tells our API server that the request it received came from you.

\n

Stages

\n

A stage is a named reference to a deployment, which is a snapshot of the API. \nhttps://partner-api.spotcap.com/{stage-name}/{resource}

\n

Beta stage with the latest version of the Partner API. It is deployed as a beta release for testing purposes.

\n

Production (v1) the stable version remains deployed as a production release for normal operations.

\n

Error Codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeMeaning
400Bad Request
401Unauthorized – Your API key is wrong
403Forbidden – The requested resource is hidden for administrators only
404Not Found – The specified resource could not be found
405Method Not Allowed – You tried to access a resource with an invalid method
406Not Acceptable – You requested a format that isn’t json
410Gone – The resource requested has been removed from our servers
429Too Many Requests
500Internal Server Error – We had a problem with our server. Try again later.
503Service Unavailable – We’re temporarily offline for maintenance.
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Leads vs. Users","slug":"leads-vs-users"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Stages","slug":"stages"},{"content":"Error Codes","slug":"error-codes"}],"owner":"4305135","collectionId":"da54570b-97c1-4256-aa0a-69bf58a8e87b","publishedId":"RW83PCBz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-05-14T20:43:15.000Z"},"item":[{"name":"Leads","id":"a8821808-c518-463e-b88b-c9dbf3c2771a","request":{"method":"POST","header":[{"key":"x-api-key","value":"*****1v8uN8auTrmV6p7B3dMut1BxLBw3Cq*****"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"name\": \"1212233\",\n \"id\": \"34139\"\n },\n \"personalDetails\": {\n \n \"email\": \"user.email@spotcap.com\",\n \"firstName\": \"User Name\",\n \"middleName\": \"User Middle Name\",\n \"lastName\": \"User Last Name\",\n \"nationality\": \"Australian\",\n \"phone\": \"555-000111\",\n \"salutation\": \"mr\",\n \"function\": \"Director\",\n \"callBackTime\": \"2018-02-23\",\n \"address\": {\n \"streetName\": \"53 Berry St\",\n \"suburb\": \"North Sydney\",\n \"zipCode\": 2060,\n \"state\": \"NSW\"\n } \n },\n \"companyDetails\": {\n \"industry\": \n\t {\n\t \"SIC\": \"25\",\n\t \"industryName\": \"Furniture and Fixtures\"\n\t },\n \"registrationNumber\": \"12345678912\",\n \"name\": \"ACME\",\n \"legalType\": \"limited\",\n \"yearsInBusiness\": 5\n },\n \"financialInfo\": {\n \"incomeLast12Month\": 1700000,\n \"profitLast12Month\": 800000,\n \"outstandingBorrowings\": 123,\n \"avgMonthlyPayments\": 123,\n \"overdraftLimit\": 20000,\n \"overdraftUsed\": 0\n }\n}"},"url":"https://partner-api.spotcap.com/beta/lead","description":"

If you want our client service and sales team to get in contact with a potential client use this endpoint. This endpoint creates a Lead object and call-task in our CRM system.

\n

A sample body is added to the request that conforms to the following JSON schema:

\n
{\n  \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"partner\": {\n          \"type\":\"object\",\n          \"properties\": {\n            \"name\": { \"type\": \"string\" },\n              \"id\":   { \"type\": \"string\" }\n          }\n      },\n    \"personalDetails\": {\n      \"type\":\"object\",\n      \"properties\": {\n        \"dateOfBirth\": { \"type\": \"string\", \"format\": \"date-time\" },\n        \"email\": { \"type\": \"string\", \"format\": \"email\" },\n        \"firstName\": { \"type\": \"string\" },\n        \"middleName\": { \"type\": \"string\" },\n        \"lastName\": { \"type\": \"string\" },\n        \"nationality\": { \"type\": \"string\" },\n        \"phone\":{ \"type\": \"string\" }, \n        \"salutation\": { \"type\": \"string\",\n                \"enum\": [\"mr\", \"mrs\", \"ms\"]\n        },\n        \"jobTitle\": { \"type\": \"string\" },\n        \"callBackTime\": { \"type\": \"string\" }, \n        \"address\": {\n          \"type\": \"object\",\n          \"properties\": { \n            \"streetName\": { \"type\": \"string\" },\n            \"suburb\": { \"type\": \"string\" },\n            \"city\": { \"type\": \"string\" },\n            \"zipCode\": { \"type\": \"number\" },\n            \"state\": { \"type\": \"string\" }\n          }\n        }\n      }\n    },\n    \"companyDetails\": {\n      \"type\":\"object\",\n      \"properties\": {\n        \"industry\": { \"type\": \"object\",\n                \"properties\": {\n                  \"SIC\": { \"type\": \"number\" },\n                  \"industryName\": {\"type\":\"string\"}\n                } \n        },\n        \"registrationNumber\": { \"type\": \"string\" },\n        \"name\": { \"type\": \"string\" },\n        \"legalType\": { \"type\": \"string\",\n        \"enum\": [\"sole trader\", \"limited\", \"partnership\", \"trust\"]\n        },\n        \"yearsInBusiness\":  { \"type\": \"number\"}\n      }\n    },\n    \"financialInfo\": {\n      \"type\":\"object\",\n      \"properties\": {\n        \"incomeLast12Month\": { \"type\": \"number\" },\n        \"profitLast12Month\": { \"type\": \"number\" },\n        \"outstandingBorrowings\": { \"type\": \"number\" },\n        \"avgMonthlyPayments\": { \"type\": \"number\" },\n        \"overdraftLimit\": { \"type\": \"number\" },\n        \"overdraftUsed\": { \"type\": \"number\" }\n      }\n    }\n  }\n}\n
","urlObject":{"protocol":"https","path":["beta","lead"],"host":["partner-api","spotcap","com"],"query":[],"variable":[]}},"response":[{"id":"a302f86f-04a9-4d13-b98e-8f2ab740e75d","name":"POST Leads","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"XXXXXXXqjY704TRIzIsbs4LIFvb7DYts8YVhfepP"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"name\": \"1212233\",\n \"id\": \"123\"\n },\n \"personalDetails\": {\n \"dateOfBirth\": \"2017-11-23T19:47:02+00:00\",\n \"email\": \"user.email@spotcap.com\",\n \"firstName\": \"User Name\",\n \"middleName\": \"User Middle Name\",\n \"lastName\": \"User Last Name\",\n \"nationality\": \"123\",\n \"phone\": \"123\",\n \"salutation\": \"123\",\n \"function\": \"123\",\n \"callBackTime\": \"123\",\n \"address\": {\n \"streetName\": \"123\",\n \"suburb\": \"123\",\n \"zipCode\": 123,\n \"state\": \"123\"\n }\n },\n \"companyDetails\": {\n \"industry\": \"123\",\n \"registrationNumber\": \"12345678912\",\n \"name\": \"ACME\",\n \"legalType\": \"c_type_limitedcompany\",\n \"yearsInBusiness\": 12\n },\n \"fundingNeeds\": {\n \"requestedAmount\": \"123\",\n \"requestedDuration\": \"123\",\n \"purpose\": \"purchase_inventory\"\n },\n \"financialInfo\": {\n \"incomeLast12Month\": 123,\n \"profitLast12Month\": 123,\n \"outstandingBorrowings\": 123,\n \"avgMonthlyPayments\": 123,\n \"overdraftLimit\": 123,\n \"overdraftUsed\": 123\n }\n}"},"url":"https://partner-api.spotcap.com/lead"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"23","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 08 Dec 2017 13:51:48 GMT","name":"Date","description":""},{"key":"Via","value":"1.1 ae3e6ab763f755c867a3b493d306312c.cloudfront.net (CloudFront)","name":"Via","description":""},{"key":"X-Amz-Cf-Id","value":"jUlniMi14xIlR2cgbqZXNS4mbSRpxi4_M0JhVHzc5XUyI6OKuoWaDQ==","name":"X-Amz-Cf-Id","description":""},{"key":"X-Cache","value":"Error from cloudfront","name":"X-Cache","description":""},{"key":"x-amzn-ErrorType","value":"ForbiddenException","name":"x-amzn-ErrorType","description":""},{"key":"x-amzn-RequestId","value":"efb008a5-dc1e-11e7-bbd4-57500b6a8d71","name":"x-amzn-RequestId","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"attempt\": \"5a1725db-f21a-415d-9caf-d576630ed1b0\",\n \"id\": \"cf8e1233-d451-43de-83b9-eeae2568aae7\",\n \"request_id\": \"5a1725db-f21a-415d-9caf-d576630ed1b0\"\n}"}],"_postman_id":"a8821808-c518-463e-b88b-c9dbf3c2771a"},{"name":"Users","id":"cad4735c-7a55-4c87-bb1c-006f1dba7910","request":{"method":"POST","header":[{"key":"x-api-key","value":"*****1v8uN8auTrmV6p7B3dMut1BxLBw3Cq*****"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"name\": \"Parner Name\",\n \"id\": \"123456\"\n },\n \"personalDetails\": {\n \"dateOfBirth\": \"2017-11-23T19:47:02+00:00\",\n \"email\": \"user.email@spotcap.com\",\n \"firstName\": \"User Name\",\n \"middleName\": \"User Middle Name\",\n \"lastName\": \"User Last Name\",\n \"nationality\": \"Australian\",\n \"phone\": \"555-000111\",\n \"salutation\": \"mr\",\n \"creditCheckConsent\": \"boolean\",\n \"address\": {\n \"streetName\": \"53 Berry St\",\n \"suburb\": \"North Sydney\",\n \"city\":\"Sydney\",\n \"zipCode\": 2060,\n \"state\": \"NSW\"\n }\n },\n \"companyDetails\": {\n \"industry\": {\n \"SIC\": 0111,\n \"industryName\": \"Bakery Products\"\n },\n \"registrationNumber\": \"12345678912\",\n \"name\": \"ACME\",\n \"legalType\": \"limited\",\n \"yearsInBusiness\": 5\n },\n \"fundingNeeds\": {\n \"requestedAmount\": \"123\",\n \"requestedDuration\": \"60_days\",\n \"purpose\": \"purchase_inventory\"\n },\n \"financialInfo\": {\n \"incomeLast12Month\": 1700000,\n \"profitLast12Month\": 800000,\n \"outstandingBorrowings\": 123,\n \"avgMonthlyPayments\": 123,\n \"overdraftLimit\": 20000,\n \"overdraftUsed\": 0\n }\n}"},"url":"https://partner-api.spotcap.com/beta/user","description":"

If you want to create an application for a client please use this endpoint. This endpoint creates a user account on the Spotcap platform. The client will be informed via email that the application was started.

\n

A sample body is added to the request that conforms to the following JSON schema:

\n
{\n  \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"partner\": {\n          \"type\":\"object\",\n          \"properties\": {\n            \"name\": { \"type\": \"string\" },\n              \"id\":   { \"type\": \"string\" }\n          }\n      },\n    \"personalDetails\": {\n      \"type\":\"object\",\n      \"properties\": {\n        \"dateOfBirth\": { \"type\": \"string\", \"format\": \"date-time\" },\n        \"email\": { \"type\": \"string\", \"format\": \"email\" },\n        \"firstName\": { \"type\": \"string\" },\n        \"middleName\": { \"type\": \"string\" },\n        \"lastName\": { \"type\": \"string\" },\n        \"nationality\": { \"type\": \"string\" },\n        \"phone\": { \"type\": \"string\" }, \n        \"salutation\": { \"type\": \"string\",\n                \"enum\": [\"mr\", \"mrs\", \"ms\"]\n        },\n        \"function\": { \"type\": \"string\" },\n        \"creditCheckConsent\": { \"type\": \"boolean\"},\n        \"address\": {\n          \"type\": \"object\",\n          \"properties\": { \n            \"streetName\": { \"type\": \"string\" },\n            \"suburb\": { \"type\": \"string\" },\n            \"city\": { \"type\": \"string\" },\n            \"zipCode\": { \"type\": \"number\" },\n            \"state\": { \"type\": \"string\" }\n          }\n        }\n      }\n    },\n    \"companyDetails\": {\n      \"type\":\"object\",\n      \"properties\": {\n        \"industry\": { \"type\": \"object\",\n                \"properties\": {\n                  \"SIC\": { \"type\": \"number\" },\n                  \"industryName\": {\"type\":\"string\"}\n              } \n        },\n        \"registrationNumber\": { \"type\": \"string\" },\n        \"name\": { \"type\": \"string\" },\n        \"legalType\": { \"type\": \"string\",\n                 \"enum\": [\"sole trader\", \"limited\", \"partnership\", \"trust\"]\n        },\n        \"yearsInBusiness\": { \"type\": \"number\" }\n      }\n    },\n    \"fundingNeeds\": {\n        \"requestedAmount\": { \"type\": \"string\" },\n        \"requestedDuration\": { \"type\": \"string\" },\n        \"purpose\": { \"type\": \"string\", \n               \"enum\": [\"purchase_inventory\", \"purchase_equipment\", \"bridging_receivable\", \"hiring_staff\", \"remodeling_renovation\", \"unexpected_expenses\", \"managing_cashflows\", \"marketing_campaigns\"]\n        }\n    },\n    \"financialInfo\": {\n      \"type\":\"object\",\n      \"properties\": {\n        \"incomeLast12Month\": { \"type\": \"number\" },\n        \"profitLast12Month\": { \"type\": \"number\" },\n        \"outstandingBorrowings\": { \"type\": \"number\" },\n        \"avgMonthlyPayments\": { \"type\": \"number\" },\n        \"overdraftLimit\": { \"type\": \"number\" },\n        \"overdraftUsed\": { \"type\": \"number\" }\n      }\n    }\n  }\n}\n
","urlObject":{"protocol":"https","path":["beta","user"],"host":["partner-api","spotcap","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cad4735c-7a55-4c87-bb1c-006f1dba7910"},{"name":"Documents","id":"66ed25ee-d4ba-4b5a-b970-5028ebe87065","request":{"method":"POST","header":[{"key":"x-api-key","value":"*****1v8uN8auTrmV6p7B3dMut1BxLBw3Cq*****"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"user.email@spotcap.com\",\n \"fileBase64\" : \"KAKnxQdYAD3LkuYkQNwgf8xviAITABRIA4kgWmwzny4TsVgJpgDFoIiUAJ...\",\n \"type\" : \"AnnualReport\",\n \"startDate\" : \"01/01/2016\",\n \"endDate\" : \"31/12/2016\"\n}"},"url":"https://partner-api.spotcap.com/beta/document","description":"

To submit financial documents for an application, please use this endpoint.

\n

The documents should be in pdf format.

\n

In the parameter email, please use the applicants email address.

\n

The fileBase64 parameter contains the file data, base64 encoded.

\n

The parameter type is used to specify the kind of financial documents. The allowed document types are: AnnualReport, BalanceSheet, BankStatements, Other, PNL, TaxReturn, TrustDeed

\n

Use the parameters startDate and endDate to specify the period covered in the documents.

\n

A sample body is added to the request that conforms to the following JSON schema:

\n
{\n  \"$schema\": \"http://json-schema.org/draft-06/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"email\": {\n          \"type\": \"string\",\n          \"format\": \"email\"\n        },\n    \"url\": {\n          \"type\": \"string\",\n          \"format\": \"email\"\n        },\n    \"type\": {\n          \"type\": \"string\",\n          \"enum\": [\"AnnualReport\", \"BalanceSheet\", \"Other\", \"PNL\", \"TaxReturn\", \"TrustDeed\"]\n        },\n      \"startDate\": {\n          \"type\": \"string\",\n          \"format\": \"date\"\n        },\n    \"endDate\": {\n          \"type\": \"string\",\n          \"format\": \"date\"\n        }\n\n    }\n}\n
","urlObject":{"protocol":"https","path":["beta","document"],"host":["partner-api","spotcap","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"66ed25ee-d4ba-4b5a-b970-5028ebe87065"},{"name":"User V1","id":"4da60c83-ebb3-410c-951d-5f47ce6cc3a2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-api-key","value":"5Huax4vBs86GutzQsQoSN3uQkJ6NdsM295RCxvMa"}],"body":{"mode":"raw","raw":"{\n \"partner\": {\n \"name\": \"\",\n \"id\": \"\"\n },\n \"personalDetails\": {\n \"email\": \"TestUser@b2cdev.com\",\n \"firstName\": \"TestUser\",\n \"middleName\": \"\",\n \"lastName\": \"Test\",\n \"nationality\": \"Australian\",\n \"phone\": \"22222222\",\n \"salutation\": \"\",\n \"function\": \"\",\n \"callBackTime\": \"\",\n \"address\": {\n \"streetName\": \"\",\n \"suburb\": \"BANOON\",\n \"zipCode\": \"2347\",\n \"state\": \"NSW\"\n }\n },\n \"companyDetails\": {\n \"industry\": \"(3323)-Industrial and Agricultural Chemical Product Wholesaling\",\n \"registrationNumber\": \"11112342343\",\n \"name\": \"Family Unit\",\n \"legalType\": \"Trust Unit\",\n \"yearsInBusiness\": 2\n },\n \"financialInfo\": {\n \"incomeLast12Month\": \"\",\n \"profitLast12Month\": \"\",\n \"outstandingBorrowings\": \"\",\n \"avgMonthlyPayments\": 0,\n \"overdraftLimit\": 0,\n \"overdraftUsed\": 0\n }\n}"},"url":"https://partner-api.spotcap.com/v1/user","urlObject":{"protocol":"https","path":["v1","user"],"host":["partner-api","spotcap","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4da60c83-ebb3-410c-951d-5f47ce6cc3a2"}],"event":[{"listen":"prerequest","script":{"id":"fae7bc56-940b-4764-875b-e88b42bc1f32","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3d881233-6a8f-4961-a0b1-7222ee4fca36","type":"text/javascript","exec":[""]}}]}