Back to top

Creditable API

Note: please consider reference number/reference/slug as slug.

Status Codes

Status Codes

When you request API using GET/POST API will return below status codes

  • Possible Errors:

    • 400 : BAD REQUEST
    • 401 : NOT ALLOWED
    • 403 : RESPONSE FORBIDDEN
  • Status Codes:

    • 200 : SUCCESS
    • 201 : CREATED

Client

Client Signup

Creditable customer in Application

Client Signup
POST/api/v1/client/signup/

Example URI

POST /api/v1/client/signup/
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Token <token-value>
Body
{
  "first_name": "Anjaneyulu",
  "last_name": "B",
  "email": "anjaneyulu.batta@micropyramid.com",
  "password": "secret",
  "confirm_password": "secret"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "Applicant's first name"
    },
    "last_name": {
      "type": "string",
      "description": "Applicant's last name"
    },
    "email": {
      "type": "string",
      "description": "Applicant's email"
    },
    "password": {
      "type": "string",
      "description": "Applicant's password"
    },
    "confirm_password": {
      "type": "string",
      "description": "Applicant's confirm password"
    }
  },
  "required": [
    "first_name",
    "last_name",
    "email",
    "password",
    "confirm_password"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "we have sent you an email.please confirm."
}

Client Login/Sign in

Client Login/Sign in

Client Login/Sign
POST/api/v1/login/

Example URI

POST /api/v1/login/
Request
HideShow
Headers
Content-Type: application/json
Accept: application/json
Authorization: Token <token-value>
Body
{
  "email": "anjaneyulu.batta@micropyramid.com",
  "password": "secret"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Applicant's email"
    },
    "password": {
      "type": "string",
      "description": "Applicant's password"
    }
  },
  "required": [
    "email",
    "password"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "token": "token-value"
}

Application for Loan/Savings

Client’s Application for Loan/Savings

Application for Loan/Savings
POST/api/v1/apply/new/:company-slug:/

Example URI

POST /api/v1/apply/new/:company-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Body
{
  "agreement_type": "Savings Plan",
  "agreement_amount": 2500,
  "loan_term": 24,
  "first_payment_date": "2016/08/15",
  "payment_frequency": 5,
  "first_name": "Ravi",
  "last_name": "G",
  "email": "ravi@micropyramid.com",
  "phone_number": "9876543210",
  "address": "Ravi G, KPHB, Micropyramid",
  "street": "Micropyramid",
  "city": "Hyderabad",
  "state": "Andra Pradesh",
  "postal_code": "500082",
  "gender": "male",
  "date_of_birth": "1991",
  "marital_status": "single",
  "ssn": "XXXXXXXXX",
  "licence_number": "XXXXX",
  "dlicence_expiry": "2030",
  "job_title": "Software Developer",
  "employer": "Ashwin",
  "employee_id": "MP026",
  "company_tel": "04065999",
  "worked_months": 60,
  "photo": "File",
  "id_proof": "File",
  "utility_bill": "File",
  "pay_slip": "File",
  "account_name": "Ravi09",
  "account_number": "115544226699",
  "bank_name": "IndusInd",
  "routing_number": "Ind4456",
  "monthly_income": 5552,
  "monthly_expenses": 1560,
  "bank_statement": "File"
}
Schema
{
  "type": "object",
  "properties": {
    "agreement_type": {
      "type": "string",
      "description": "It describes about type of loan plan. Other possible values for loan type are 'Auto & Vehicle Loan', 'Savings Plan', 'Personal Loan', 'Home Improvement', 'Education Loan', 'Vacation Loan', 'Wedding & Engagement Loan', 'Consolidate Debt', 'Insurance Plan', 'Holiday Season Loan', 'Other Short-Term Loan', 'Loans to Help Friends & Family', 'Medical Loan'"
    },
    "agreement_amount": {
      "type": "number",
      "description": "Amount for loan/savings"
    },
    "loan_term": {
      "type": "number",
      "description": "Term of Agreement in Months"
    },
    "first_payment_date": {
      "type": "string",
      "description": "First payment date of an agreement [2016-08-15]"
    },
    "payment_frequency": {
      "type": "number",
      "description": "Payment freequency in terms of months[0.04 for daily, 0.25 for weekly, 0.5 for biweekly, 1 for monthly, 12 for yearly]"
    },
    "first_name": {
      "type": "string",
      "description": "Provide your First Name"
    },
    "last_name": {
      "type": "string",
      "description": "Provide your Last Name"
    },
    "email": {
      "type": "string",
      "description": "Please provide your email"
    },
    "phone_number": {
      "type": "string",
      "description": "Please provide your phone number"
    },
    "address": {
      "type": "string",
      "description": "Please provide your address"
    },
    "street": {
      "type": "string",
      "description": "Please provide your street"
    },
    "city": {
      "type": "string",
      "description": "Please provide your city"
    },
    "state": {
      "type": "string",
      "description": "Please provide your state"
    },
    "postal_code": {
      "type": "string",
      "description": "Postal Index Number"
    },
    "gender": {
      "type": "string",
      "description": "Possible gender types 'male', 'female', 'other'"
    },
    "date_of_birth": {
      "type": "string",
      "description": "08-12 (string, required) - Date of birth"
    },
    "marital_status": {
      "type": "string",
      "description": "possible values 'single', 'married', 'partnership', 'divorced'"
    },
    "ssn": {
      "type": "string",
      "description": "Identity Number"
    },
    "licence_number": {
      "type": "string",
      "description": "Driving Licence Number"
    },
    "dlicence_expiry": {
      "type": "string",
      "description": "12-19 (string, required) - Driving Licence expiry date"
    },
    "job_title": {
      "type": "string",
      "description": "Working Job Title"
    },
    "employer": {
      "type": "string",
      "description": "Name of employer"
    },
    "employee_id": {
      "type": "string",
      "description": "Employee Identity Number"
    },
    "company_tel": {
      "type": "string",
      "description": "Company telephone number"
    },
    "worked_months": {
      "type": "number",
      "description": "Number of worked months"
    },
    "photo": {
      "type": "string",
      "description": "Provide your picture [File]"
    },
    "id_proof": {
      "type": "string",
      "description": "Identification Proof [File]"
    },
    "utility_bill": {
      "type": "string",
      "description": "Utility Bill [File]"
    },
    "pay_slip": {
      "type": "string",
      "description": "Payment bills [File]"
    },
    "account_name": {
      "type": "string",
      "description": "Bank account name"
    },
    "account_number": {
      "type": "string",
      "description": "Bank account number"
    },
    "bank_name": {
      "type": "string",
      "description": "Name of the bank"
    },
    "routing_number": {
      "type": "string",
      "description": "Bank routing code"
    },
    "monthly_income": {
      "type": "number",
      "description": "Monthly income"
    },
    "monthly_expenses": {
      "type": "number",
      "description": "Monthly expenses"
    },
    "bank_statement": {
      "type": "string",
      "description": "Bank statement [File]"
    }
  },
  "required": [
    "agreement_type",
    "agreement_amount",
    "loan_term",
    "first_payment_date",
    "payment_frequency",
    "first_name",
    "last_name",
    "email",
    "phone_number",
    "address",
    "street",
    "city",
    "state",
    "postal_code",
    "gender",
    "marital_status",
    "ssn",
    "licence_number",
    "job_title",
    "employer",
    "employee_id",
    "company_tel",
    "worked_months",
    "photo",
    "id_proof",
    "utility_bill",
    "pay_slip",
    "account_name",
    "account_number",
    "bank_name",
    "routing_number",
    "monthly_income",
    "monthly_expenses",
    "bank_statement"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Your application was successfully submitted"
}

List applications

Client’s All Applications of a Company

List applications
GET/api/v1/applications/company/:company-slug:/client/:client-slug:/

Example URI

GET /api/v1/applications/company/:company-slug:/client/:client-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "profile_picture_url": "/api/v1/applications/f35gn38czg/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/f35gn38czg/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/f35gn38czg/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/f35gn38czg/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/f35gn38czg/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "f35gn38czg",
    "client_company_phone": "+27 9887465521",
    "account_number": "123456",
    "gender": "male",
    "marital_status": null,
    "dependents": "0",
    "date_of_birth": "1995-06-12",
    "job_title": null,
    "employer": null,
    "employee_id": null,
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "approved",
    "created": "2016-06-14T08:25:53.095127Z",
    "updated": "2016-06-15T07:42:50.788710Z",
    "worked_months": 12,
    "first_name": "shera",
    "last_name": "s",
    "phone_number": "+27 9874563210",
    "client_type": "natural_person",
    "ssn": null,
    "company_no": null,
    "address": "hyd",
    "street": "sdfsd",
    "city": "hyd",
    "state": "tel",
    "postal_code": "12313",
    "monthly_income": "1680.00",
    "monthly_expenses": "-90.00",
    "balance": "0.00",
    "customer_notes": null,
    "email": "anjaneyulu.test@gmail.com",
    "account_name": "anji123",
    "bank_name": "bank of baroda",
    "routing_number": "abcd12",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Home Improvement",
    "loan_description": null,
    "agreement_amount": "200.00",
    "currency": "ZAR",
    "loan_term": 12,
    "first_payment_date": "2016-11-11",
    "licence_number": null,
    "dlicence_expiry": null
  },
  {
    "profile_picture_url": "/api/v1/applications/up9f6zmhda/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/up9f6zmhda/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/up9f6zmhda/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/up9f6zmhda/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/up9f6zmhda/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "up9f6zmhda",
    "client_company_phone": "+27 9887465521",
    "account_number": "123456",
    "gender": "male",
    "marital_status": "single",
    "dependents": "0",
    "date_of_birth": "1995-06-12",
    "job_title": null,
    "employer": null,
    "employee_id": "emp123",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "approved",
    "created": "2016-06-14T09:24:44.672176Z",
    "updated": "2016-06-14T13:10:13.418943Z",
    "worked_months": 12,
    "first_name": "shera",
    "last_name": "s",
    "phone_number": "+27 9874563210",
    "client_type": "natural_person",
    "ssn": "id45653123",
    "company_no": null,
    "address": "hyd",
    "street": "sdfsd",
    "city": "hyd",
    "state": "tel",
    "postal_code": "12313",
    "monthly_income": "1680.00",
    "monthly_expenses": "-90.00",
    "balance": "0.00",
    "customer_notes": null,
    "email": "anjaneyulu.test@gmail.com",
    "account_name": "anji123",
    "bank_name": "bank of baroda",
    "routing_number": "abcd12",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Home Improvement",
    "loan_description": null,
    "agreement_amount": "200.00",
    "currency": "ZAR",
    "loan_term": 12,
    "first_payment_date": "2016-11-11",
    "licence_number": null,
    "dlicence_expiry": null
  }
]

Client's Single Application of a Company

Client’s Single Application of a Company

Client's Single Application of a Company
GET/api/v1/applications/:company-slug:/:application-reference-number:/

Example URI

GET /api/v1/applications/:company-slug:/:application-reference-number:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "profile_picture_url": "/api/v1/applications/f35gn38czg/profile-picture/download/",
  "id_proof_url": "/api/v1/applications/f35gn38czg/id-proof/download/",
  "utility_bill_url": "/api/v1/applications/f35gn38czg/utility-bill/download/",
  "pay_slip_url": "/api/v1/applications/f35gn38czg/pay-slip/download/",
  "bank_statement_url": "/api/v1/applications/f35gn38czg/bank-statement/download/",
  "payment_freequency": "Monthly",
  "reference_number": "f35gn38czg",
  "client_company_phone": "+27 9887465521",
  "account_number": "123456",
  "gender": "male",
  "marital_status": null,
  "dependents": "0",
  "date_of_birth": "1995-06-12",
  "job_title": null,
  "employer": null,
  "employee_id": null,
  "date_of_incorporation": null,
  "name_of_contact": null,
  "number_of_employees": null,
  "status": "approved",
  "created": "2016-06-14T08:25:53.095127Z",
  "updated": "2016-06-15T07:42:50.788710Z",
  "worked_months": 12,
  "first_name": "shera",
  "last_name": "s",
  "phone_number": "+27 9874563210",
  "client_type": "natural_person",
  "ssn": null,
  "company_no": null,
  "address": "hyd",
  "street": "sdfsd",
  "city": "hyd",
  "state": "tel",
  "postal_code": "12313",
  "monthly_income": "1680.00",
  "monthly_expenses": "-90.00",
  "balance": "0.00",
  "customer_notes": null,
  "email": "anjaneyulu.test@gmail.com",
  "account_name": "anji123",
  "bank_name": "bank of baroda",
  "routing_number": "abcd12",
  "iban": "",
  "bank_acc_name": "",
  "agreement_type": "Home Improvement",
  "loan_description": null,
  "agreement_amount": "200.00",
  "currency": "ZAR",
  "loan_term": 12,
  "first_payment_date": "2016-11-11",
  "licence_number": null,
  "dlicence_expiry": null
}

Download Document of an Application

Download Document of an Application

Download Document of an Application
GET/api/v1/applications/:reference-number:/:document-slug:/download/

document-slug: possible values [profile-picture, id-proof, utility-bill, bank-statement, pay-slip]

Example URI

GET /api/v1/applications/:reference-number:/:document-slug:/download/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: file
Body
Requested document will be downloaded

Client's All Account's Details

Client’s All Account’s Details

Client's All Account's Details
GET/api/v1/client/:client-slug:/accounts/

Example URI

GET /api/v1/client/:client-slug:/accounts/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "acc": "112233445",
    "balance": "0.00",
    "bank_acc_name": "",
    "bank_name": "cicicr",
    "created": "2016-04-20T05:45:51.269582Z",
    "iban": "",
    "name": "anji112233",
    "routing_number": "abcd112",
    "slug": "442jjqtjx9",
    "updated": "2016-04-20T05:59:18.232215Z",
    "id": 16
  },
  {
    "acc": "123456",
    "balance": "0.00",
    "bank_acc_name": "",
    "bank_name": "bank of baroda",
    "created": "2016-06-14T07:45:49.734192Z",
    "iban": "",
    "name": "anji123",
    "routing_number": "abcd12",
    "slug": "fje8q8a16c",
    "updated": "2016-06-14T13:10:13.469643Z",
    "id": 24
  }
]

Client's Single Account Details

Client’s Single Account Details

Client's Single Account Details
GET/api/v1/client/:client-slug:/accounts/:account-id:/

Example URI

GET /api/v1/client/:client-slug:/accounts/:account-id:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "acc": "112233445",
  "balance": "0.00",
  "bank_acc_name": "",
  "bank_name": "cicicr",
  "created": "2016-04-20T05:45:51.269582Z",
  "iban": "",
  "name": "anji112233",
  "routing_number": "abcd112",
  "slug": "442jjqtjx9",
  "updated": "2016-04-20T05:59:18.232215Z",
  "id": 16
}

Client's Transactions for an Account

Client’s Transactions for an Account

Client's Transactions for an Account
GET/api/v1/client/:client-slug:/account-transactions/:account-id:/

Example URI

GET /api/v1/client/:client-slug:/account-transactions/:account-id:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "category": null,
    "transaction_account_id": null,
    "account": null,
    "loan_account": 16,
    "transaction_type": "normal",
    "amount": "1000.00",
    "currency_code": "USD",
    "made_on": null,
    "balance": null,
    "transaction_id": null,
    "description": null
  },
  {
    "category": null,
    "transaction_account_id": null,
    "account": null,
    "loan_account": 16,
    "transaction_type": "normal",
    "amount": "1000.00",
    "currency_code": "USD",
    "made_on": null,
    "balance": null,
    "transaction_id": null,
    "description": null
  },
  {
    "category": null,
    "transaction_account_id": null,
    "account": null,
    "loan_account": 16,
    "transaction_type": null,
    "amount": "4500.00",
    "currency_code": "USD",
    "made_on": "2010-02-05",
    "balance": null,
    "transaction_id": null,
    "description": "bank statement description"
  }
]

Create an Account Transaction

Create an Account Transaction

Create an Account Transaction
POST/api/v1/client/:client-slug:/account/:account-id:/create-transaction/

Example URI

POST /api/v1/client/:client-slug:/account/:account-id:/create-transaction/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Body
{
  "category": "finance",
  "transaction_account_id": 442,
  "account": 12,
  "loan_account": 212,
  "transaction_type": "normal",
  "amount": 200,
  "currency_code": "USD",
  "made_on": "2016/01/12",
  "balance": 300,
  "transaction_id": 545,
  "description": "financial transaction"
}
Schema
{
  "type": "object",
  "properties": {
    "category": {
      "type": "string",
      "description": "Transaction category"
    },
    "transaction_account_id": {
      "type": "number",
      "description": "Transaction account id"
    },
    "account": {
      "type": "number",
      "description": "saltedge account id"
    },
    "loan_account": {
      "type": "number",
      "description": "loan account id"
    },
    "transaction_type": {
      "type": "string",
      "description": "type of the transaction. allowed transaction types 'transfer', 'fee', 'other', 'normal'"
    },
    "amount": {
      "type": "number",
      "description": "transaction amount"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code for transaction example: INR, USD etc."
    },
    "made_on": {
      "type": "string",
      "description": "(string, required) - Transaction Date(format: yyyy-mm-dd)"
    },
    "balance": {
      "type": "number",
      "description": "balance after transaction was made."
    },
    "transaction_id": {
      "type": "number",
      "description": "Id of transaction"
    },
    "description": {
      "type": "string",
      "description": "Description about transaction"
    }
  },
  "required": [
    "category",
    "transaction_account_id",
    "transaction_type",
    "amount",
    "currency_code",
    "balance",
    "transaction_id",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Transaction created."
}

Client's All Agreements of a Company

Client’s All Agreements of a Company

Client's All Agreements of a Company
GET/api/v1/agreements/company/:company-slug:/client/:client-slug:/

Example URI

GET /api/v1/agreements/company/:company-slug:/client/:client-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "reference_number": "qyheqcapn4",
    "annual_interests": "0.0",
    "is_signed": false,
    "collateral_value": 0,
    "created": "2016-06-20T11:20:55.958806Z",
    "currency": "ZAR",
    "payment_freequency": "Weekly",
    "days_until_penalty": 1,
    "description": "sdfsdf",
    "first_payment_date": "2016-12-12",
    "late_fee_per_day": "0.00",
    "agreement_amount": "2003.00",
    "loan_term": 12,
    "agreement_type": "Home Improvement",
    "modified": "2016-06-20T11:21:00.171542Z",
    "monthly_fee": "0.00",
    "number_of_payments": 48,
    "payment_amount": "41.73",
    "rate_per_period": "0.00",
    "total_fee": "0.00",
    "total_interest": "0.00",
    "total_payments": "2003.00",
    "is_paid": false,
    "outstanding": 2003.0400000000006
  },
  {
    "reference_number": "uiwtd7zowj",
    "annual_interests": "12.0",
    "is_signed": true,
    "collateral_value": 0,
    "created": "2016-04-20T05:59:59.910623Z",
    "currency": "USD",
    "payment_freequency": "Monthly",
    "days_until_penalty": 1,
    "description": "education loan",
    "first_payment_date": "2016-04-30",
    "late_fee_per_day": "0.00",
    "agreement_amount": "2300.00",
    "loan_term": 24,
    "agreement_type": "Education Loan",
    "modified": "2016-04-20T06:19:00.013183Z",
    "monthly_fee": "1.00",
    "number_of_payments": 24,
    "payment_amount": "101.94",
    "rate_per_period": "0.50",
    "total_fee": "24.00",
    "total_interest": "146.50",
    "total_payments": "2470.50",
    "is_paid": false,
    "outstanding": 2367.620000000001
  }
]

Client's Single Agreements of a Company

Client’s Single Agreements of a Company

Client's Single Agreements of a Company
GET/api/v1/agreements/:company-slug:/:agreement-slug:/

Example URI

GET /api/v1/agreements/:company-slug:/:agreement-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "reference_number": "5l7598c42m",
  "annual_interests": "11.0",
  "is_signed": false,
  "collateral_value": 0,
  "created": "2016-06-07T09:18:53.672171Z",
  "currency": "USD",
  "payment_freequency": "Monthly",
  "days_until_penalty": 1,
  "description": "app desc",
  "first_payment_date": "2016-05-17",
  "late_fee_per_day": "0.00",
  "agreement_amount": "5000.00",
  "loan_term": 5,
  "agreement_type": "Auto & Vehicle Loan",
  "modified": "2016-06-07T09:18:56.876614Z",
  "monthly_fee": "12.00",
  "number_of_payments": 5,
  "payment_amount": "1066.96",
  "rate_per_period": "2.20",
  "total_fee": "60.00",
  "total_interest": "334.79",
  "total_payments": "5394.79",
  "is_paid": false,
  "outstanding": 5394.8
}

Client's Approval/Acceptance for an Agreement

Client’s Approval/Acceptance for an Agreement

Client's Approval/Acceptance for an Agreement
GET/api/v1/agreement/approve/:agreement-slug:/

Example URI

GET /api/v1/agreement/approve/:agreement-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "You have accepted agreement."
}

Company Payments of a Client

Company Payments of a Client

Company Payments of a Client
GET/api/v1/payments/:company-slug:/:client-slug:/

Example URI

GET /api/v1/payments/:company-slug:/:client-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 2345,
    "loan": 17,
    "number": 1,
    "date": "2016-04-30",
    "amount": "102.94",
    "interest": "11.50",
    "principal": "90.44",
    "balance": "2209.56",
    "created": "2016-04-20T06:19:00.032521Z",
    "updated": "2016-06-20T07:49:32.707516Z",
    "status": "paid"
  },
  {
    "id": 2346,
    "loan": 17,
    "number": 2,
    "date": "2016-05-30",
    "amount": "102.94",
    "interest": "11.05",
    "principal": "90.89",
    "balance": "2118.67",
    "created": "2016-04-20T06:19:00.037418Z",
    "updated": "2016-04-20T06:19:00.037458Z",
    "status": "late"
  },
  {
    "id": 2771,
    "loan": 34,
    "number": 4,
    "date": "2017-01-02",
    "amount": "41.73",
    "interest": "0.00",
    "principal": "41.73",
    "balance": "1836.08",
    "created": "2016-06-20T11:21:00.243434Z",
    "updated": "2016-06-20T11:21:00.243502Z",
    "status": null
  }
]

Client's Agreement Payments of a Company

Client’s Agreement Payments of a Company

Client's Agreement Payments of a Company
GET/api/v1/payments/:company-slug:/:client-slug:/:agreement-reference-number:/

Example URI

GET /api/v1/payments/:company-slug:/:client-slug:/:agreement-reference-number:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 2345,
    "loan": 17,
    "number": 1,
    "date": "2016-04-30",
    "amount": "102.94",
    "interest": "11.50",
    "principal": "90.44",
    "balance": "2209.56",
    "created": "2016-04-20T06:19:00.032521Z",
    "updated": "2016-06-20T07:49:32.707516Z",
    "status": "paid"
  },
  {
    "id": 2346,
    "loan": 17,
    "number": 2,
    "date": "2016-05-30",
    "amount": "102.94",
    "interest": "11.05",
    "principal": "90.89",
    "balance": "2118.67",
    "created": "2016-04-20T06:19:00.037418Z",
    "updated": "2016-04-20T06:19:00.037458Z",
    "status": "late"
  }
]

Company Employee

Creditable customer(company) employee

Company All Clients

Company All Clients

Company All Clients
GET/api/v1/clients/:company-slug:/

Example URI

GET /api/v1/clients/:company-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
   {
        "first_name": "anji",
        "last_name": "b",
        "phone_number": "+91-9491618436",
        "address": "warangal",
        "monthly_income": "0.00",
        "monthly_expenses": "0.00",
        "customer_notes": null,
        "reference": "anji-b",
    },
    {
        "first_name": "ravi",
        "last_name": "kumar",
        "phone_number": "+91-9440736864",
        "address": "hig499",
        "monthly_income": "0.00",
        "monthly_expenses": "0.00",
        "customer_notes": null,
        "reference": "ravi-kumar",
    }
]

Company Client Details

Company Client Details

Company Client Details
GET/api/v1/client/:company-slug:/:client-slug:/

Example URI

GET /api/v1/client/:company-slug:/:client-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "first_name": "anji",
    "last_name": "b",
    "phone_number": "+91-9491618436",
    "address": "warangal",
    "monthly_income": "0.00",
    "monthly_expenses": "0.00",
    "customer_notes": null,
    "reference": "anji-b",
}

Company All Applications

Company All Applications

Company All Applications
GET/api/v1/applications/:company-slug:/

Example URI

GET /api/v1/applications/:company-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "profile_picture_url": "/api/v1/applications/ke8zyjde98/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/ke8zyjde98/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/ke8zyjde98/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/ke8zyjde98/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/ke8zyjde98/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "ke8zyjde98",
    "client_company_phone": "+91-9440736864",
    "account_number": "",
    "gender": "male",
    "marital_status": "divorced",
    "dependents": "0",
    "date_of_birth": "2016-04-11",
    "job_title": "sw",
    "employer": "mp",
    "employee_id": "12345",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "unreviewed",
    "created": "2016-04-21T11:05:25.954431Z",
    "updated": "2016-04-21T11:05:25.954470Z",
    "worked_months": 30,
    "first_name": "ravi",
    "last_name": "kumar",
    "phone_number": "+91-9440736864",
    "client_type": "natural_person",
    "ssn": "12345",
    "company_no": null,
    "address": "hig499",
    "street": "",
    "city": "",
    "state": "",
    "postal_code": "",
    "monthly_income": "4.00",
    "monthly_expenses": "0.00",
    "balance": "0.00",
    "customer_notes": null,
    "email": "ravi@mp.com",
    "account_name": "Simple account 1 MasterCard",
    "bank_name": "Fake Bank Simple",
    "routing_number": "fakebank_simple_xf",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Home Improvement",
    "loan_description": null,
    "agreement_amount": "2000.00",
    "currency": "USD",
    "loan_term": 12,
    "first_payment_date": "2016-04-18",
    "licence_number": null,
    "dlicence_expiry": "2016-05-11"
  },
  {
    "profile_picture_url": "/api/v1/applications/5fqzt4cxha/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/5fqzt4cxha/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/5fqzt4cxha/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/5fqzt4cxha/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/5fqzt4cxha/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "5fqzt4cxha",
    "client_company_phone": "+27-118984342",
    "account_number": "",
    "gender": "male",
    "marital_status": "single",
    "dependents": "0",
    "date_of_birth": "1983-06-28",
    "job_title": "Manager",
    "employer": "Creditable",
    "employee_id": "101",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "approved",
    "created": "2016-05-11T10:10:51.330825Z",
    "updated": "2016-05-18T07:36:48.321201Z",
    "worked_months": 48,
    "first_name": "Sechaba",
    "last_name": "Ngwenya",
    "phone_number": "+27-817424321",
    "client_type": "natural_person",
    "ssn": "8306285151081",
    "company_no": null,
    "address": "Dunkeld Corner, 275 Jan Smuts Avenue",
    "street": "",
    "city": "",
    "state": "",
    "postal_code": "",
    "monthly_income": "0.00",
    "monthly_expenses": "0.00",
    "balance": "0.00",
    "customer_notes": null,
    "email": "sechabangwenya+crd@gmail.com",
    "account_name": "Simple account 1 MasterCard",
    "bank_name": "Fake Bank Simple",
    "routing_number": "fakebank_simple_xf",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Auto & Vehicle Loan",
    "loan_description": null,
    "agreement_amount": "500.00",
    "currency": "USD",
    "loan_term": 12,
    "first_payment_date": "2016-05-31",
    "licence_number": null,
    "dlicence_expiry": "2016-05-11"
  },
  {
    "profile_picture_url": "/api/v1/applications/r9ls486r5a/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/r9ls486r5a/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/r9ls486r5a/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/r9ls486r5a/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/r9ls486r5a/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "r9ls486r5a",
    "client_company_phone": "+27 9874563210",
    "account_number": "",
    "gender": "male",
    "marital_status": "married",
    "dependents": "0",
    "date_of_birth": "2016-06-29",
    "job_title": "dev",
    "employer": "hello",
    "employee_id": "emp112",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "approved",
    "created": "2016-06-01T07:34:59.273348Z",
    "updated": "2016-06-03T08:17:51.128498Z",
    "worked_months": 12,
    "first_name": "rak",
    "last_name": "p",
    "phone_number": "+27 9874563210",
    "client_type": "natural_person",
    "ssn": "112233",
    "company_no": null,
    "address": "w",
    "street": "w",
    "city": "w",
    "state": "w",
    "postal_code": "w",
    "monthly_income": "24.36",
    "monthly_expenses": "14.00",
    "balance": "2010.10",
    "customer_notes": null,
    "email": "ww@ww.cd",
    "account_name": "Oauth account 2",
    "bank_name": "Fake Bank OAuth",
    "routing_number": "fakebank_oauth_xf",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Auto & Vehicle Loan",
    "loan_description": null,
    "agreement_amount": "220.00",
    "currency": "ZAR",
    "loan_term": 22,
    "first_payment_date": "2016-06-22",
    "licence_number": "12365",
    "dlicence_expiry": "2016-06-18"
  },
]

Company Application Details

Company Application Details

Company Application Details
GET/api/v1/applications/:company-slug:/:application-reference-number:/

Example URI

GET /api/v1/applications/:company-slug:/:application-reference-number:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "profile_picture_url": "/api/v1/applications/f35gn38czg/profile-picture/download/",
  "id_proof_url": "/api/v1/applications/f35gn38czg/id-proof/download/",
  "utility_bill_url": "/api/v1/applications/f35gn38czg/utility-bill/download/",
  "pay_slip_url": "/api/v1/applications/f35gn38czg/pay-slip/download/",
  "bank_statement_url": "/api/v1/applications/f35gn38czg/bank-statement/download/",
  "payment_freequency": "Monthly",
  "reference_number": "f35gn38czg",
  "client_company_phone": "+27 9887465521",
  "account_number": "123456",
  "gender": "male",
  "marital_status": null,
  "dependents": "0",
  "date_of_birth": "1995-06-12",
  "job_title": null,
  "employer": null,
  "employee_id": null,
  "date_of_incorporation": null,
  "name_of_contact": null,
  "number_of_employees": null,
  "status": "approved",
  "created": "2016-06-14T08:25:53.095127Z",
  "updated": "2016-06-15T07:42:50.788710Z",
  "worked_months": 12,
  "first_name": "shera",
  "last_name": "s",
  "phone_number": "+27 9874563210",
  "client_type": "natural_person",
  "ssn": null,
  "company_no": null,
  "address": "hyd",
  "street": "sdfsd",
  "city": "hyd",
  "state": "tel",
  "postal_code": "12313",
  "monthly_income": "1680.00",
  "monthly_expenses": "-90.00",
  "balance": "0.00",
  "customer_notes": null,
  "email": "anjaneyulu.test@gmail.com",
  "account_name": "anji123",
  "bank_name": "bank of baroda",
  "routing_number": "abcd12",
  "iban": "",
  "bank_acc_name": "",
  "agreement_type": "Home Improvement",
  "loan_description": null,
  "agreement_amount": "200.00",
  "currency": "ZAR",
  "loan_term": 12,
  "first_payment_date": "2016-11-11",
  "licence_number": null,
  "dlicence_expiry": null
}

Company Download Document of an Application

Company Download Document of an Application

Company Download Document of an Application
GET/api/v1/applications/:reference-number:/:document-slug:/download/

document-slug: possible values [profile-picture, id-proof, utility-bill, bank-statement, pay-slip]

Example URI

GET /api/v1/applications/:reference-number:/:document-slug:/download/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: file
Body
requested document will be downloaded

Company Approve/Disapprove an Application

Company Approve/Disapprove an Application

Company Approve/Disapprove an Application
POST/api/v1/applications/:company-slug:/:reference-number:/:slug:/

slug: possible values [approve, decline]

Example URI

POST /api/v1/applications/:company-slug:/:reference-number:/:slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "application approved/declined"
}

Company Create Loan/Agreement from an Application

Company Create Loan/Agreement from an Application

Company Create Loan/Agreement from an Application
GET/api/v1/loan/:company-slug:/:client-slug:/:account-slug:/:application-reference-number:/create/

Initial Data: initial values for form data

Example URI

GET /api/v1/loan/:company-slug:/:client-slug:/:account-slug:/:application-reference-number:/create/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "description": "",
  "currency": "ZAR",
  "agreement_amount": "200.00",
  "annual_interests": "0.0",
  "loan_term": 12,
  "monthly_fee": "0.00",
  "first_payment_date": "2016-11-11",
  "payment_frequency": 1,
  "days_until_penalty": 1,
  "late_fee_per_day": "0.00",
  "late_fee_per_month": "0.00",
  "agreement_type": "Home Improvement",
  "collateral_value": 0
}

Company Create Loan/Agreement from an Application

Company Create Loan/Agreement from an Savings Application

Company Create Loan/Agreement from an Application
POST/api/v1/loan/:company-slug:/:client-slug:/:account-slug:/:application-reference-number:/create/

Example URI

POST /api/v1/loan/:company-slug:/:client-slug:/:account-slug:/:application-reference-number:/create/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Body
{
  "description": "savings loan",
  "currency": "USD",
  "agreement_amount": 300,
  "loan_term": 40,
  "payment_frequency": 12,
  "first_payment_date": "2016/12/15",
  "collateral_value": 2
}
Schema
{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Description about savings plan"
    },
    "currency": {
      "type": "string",
      "description": "Currency for savings plan (currency choices: USD, INR, etc)"
    },
    "agreement_amount": {
      "type": "number",
      "description": "Amount for savings plan"
    },
    "loan_term": {
      "type": "number",
      "description": "savings plan term in number of months"
    },
    "payment_frequency": {
      "type": "number",
      "description": "Payment freequency in terms of months[0.04 for daily, 0.25 for weekly, 0.5 for biweekly, 1 for monthly, 12 for yearly]"
    },
    "first_payment_date": {
      "type": "string",
      "description": "First payment date (format: yyyy-mm-dd)"
    },
    "collateral_value": {
      "type": "number",
      "description": "Collateral value"
    }
  },
  "required": [
    "description",
    "currency",
    "agreement_amount",
    "loan_term",
    "payment_frequency",
    "first_payment_date",
    "collateral_value"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Loan created."
}

Company Create Loan/Agreement from an Application

Company Create Loan/Agreement from an Loan Application

Company Create Loan/Agreement from an Application
POST/api/v1/loan/:company-slug:/:client-slug:/:account-slug:/:application-reference-number:/create/

Example URI

POST /api/v1/loan/:company-slug:/:client-slug:/:account-slug:/:application-reference-number:/create/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Body
{
  "description": "Home Improvement Loan",
  "currency": "USD",
  "agreement_amount": 300,
  "annual_interests": 2,
  "loan_term": 40,
  "monthly_fee": 12,
  "first_payment_date": "2016/12/15",
  "payment_frequency": 12,
  "days_until_penalty": 12,
  "late_fee_per_day": 2,
  "late_fee_per_month": 25
}
Schema
{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Description about savings plan"
    },
    "currency": {
      "type": "string",
      "description": "Currency for Type of Loan (currency choices: USD, INR, etc)"
    },
    "agreement_amount": {
      "type": "number",
      "description": "Amount for Type of Loan"
    },
    "annual_interests": {
      "type": "number",
      "description": "Annual interest charge in percentage"
    },
    "loan_term": {
      "type": "number",
      "description": "loan term in number of months"
    },
    "monthly_fee": {
      "type": "number",
      "description": "Monthly fee"
    },
    "first_payment_date": {
      "type": "string",
      "description": "First payment date (format: yyyy-mm-dd)"
    },
    "payment_frequency": {
      "type": "number",
      "description": "Payment freequency in terms of months[0.04 for daily, 0.25 for weekly, 0.5 for biweekly, 1 for monthly, 12 for yearly]"
    },
    "days_until_penalty": {
      "type": "number",
      "description": "Days until penalty"
    },
    "late_fee_per_day": {
      "type": "number",
      "description": "Late fee for a day"
    },
    "late_fee_per_month": {
      "type": "number",
      "description": "Late fee for a month"
    }
  },
  "required": [
    "description",
    "currency",
    "agreement_amount",
    "annual_interests",
    "loan_term",
    "monthly_fee",
    "first_payment_date",
    "payment_frequency",
    "days_until_penalty",
    "late_fee_per_day",
    "late_fee_per_month"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Loan created."
}

Company All Account's of a Client

Company All Account’s of a Client

Company All Account's of a Client
GET/api/v1/client/:client-slug:/accounts/

Example URI

GET /api/v1/client/:client-slug:/accounts/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "acc": "112233445",
    "balance": "0.00",
    "bank_acc_name": "",
    "bank_name": "cicicr",
    "created": "2016-04-20T05:45:51.269582Z",
    "iban": "",
    "name": "anji112233",
    "routing_number": "abcd112",
    "slug": "442jjqtjx9",
    "updated": "2016-04-20T05:59:18.232215Z",
    "id": 16
  },
  {
    "acc": "123456",
    "balance": "0.00",
    "bank_acc_name": "",
    "bank_name": "bank of baroda",
    "created": "2016-06-14T07:45:49.734192Z",
    "iban": "",
    "name": "anji123",
    "routing_number": "abcd12",
    "slug": "fje8q8a16c",
    "updated": "2016-06-14T13:10:13.469643Z",
    "id": 24
  }
]

Company Account Details

Company Account Details

Company Account Details
GET/api/v1/client/:client-slug:/accounts/:account-id:/

Example URI

GET /api/v1/client/:client-slug:/accounts/:account-id:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "acc": "112233445",
  "balance": "0.00",
  "bank_acc_name": "",
  "bank_name": "cicicr",
  "created": "2016-04-20T05:45:51.269582Z",
  "iban": "",
  "name": "anji112233",
  "routing_number": "abcd112",
  "slug": "442jjqtjx9",
  "updated": "2016-04-20T05:59:18.232215Z",
  "id": 16
}

Company Client's Transactions for an Account

Company Client’s Transactions for an Account

Company Client's Transactions for an Account
GET/api/v1/client/:client-slug:/account-transactions/:account-id:/

Example URI

GET /api/v1/client/:client-slug:/account-transactions/:account-id:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "category": null,
    "transaction_account_id": null,
    "account": null,
    "loan_account": 16,
    "transaction_type": "normal",
    "amount": "1000.00",
    "currency_code": "USD",
    "made_on": null,
    "balance": null,
    "transaction_id": null,
    "description": null
  },
  {
    "category": null,
    "transaction_account_id": null,
    "account": null,
    "loan_account": 16,
    "transaction_type": "normal",
    "amount": "1000.00",
    "currency_code": "USD",
    "made_on": null,
    "balance": null,
    "transaction_id": null,
    "description": null
  },
  {
    "category": null,
    "transaction_account_id": null,
    "account": null,
    "loan_account": 16,
    "transaction_type": null,
    "amount": "4500.00",
    "currency_code": "USD",
    "made_on": "2010-02-05",
    "balance": null,
    "transaction_id": null,
    "description": "bank statement description"
  }
]

Company Create an Account Transaction

Company Create an Account Transaction

Company Create an Account Transaction
POST/api/v1/client/:client-slug:/account/:account-id:/create-transaction/

Example URI

POST /api/v1/client/:client-slug:/account/:account-id:/create-transaction/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Body
{
  "category": "finance",
  "transaction_account_id": 442,
  "account": 12,
  "loan_account": 212,
  "transaction_type": "normal",
  "amount": 200,
  "currency_code": "USD",
  "made_on": "2016/01/12",
  "balance": 300,
  "transaction_id": 545,
  "description": "financial transaction"
}
Schema
{
  "type": "object",
  "properties": {
    "category": {
      "type": "string",
      "description": "Transaction category"
    },
    "transaction_account_id": {
      "type": "number",
      "description": "Transaction account id"
    },
    "account": {
      "type": "number",
      "description": "saltedge account id"
    },
    "loan_account": {
      "type": "number",
      "description": "loan account id"
    },
    "transaction_type": {
      "type": "string",
      "description": "type of the transaction. allowed transaction types 'transfer', 'fee', 'other', 'normal'"
    },
    "amount": {
      "type": "number",
      "description": "transaction amount"
    },
    "currency_code": {
      "type": "string",
      "description": "Currency code for transaction example: INR, USD etc."
    },
    "made_on": {
      "type": "string",
      "description": "(string, required) - Transaction Date(format: yyyy-mm-dd)"
    },
    "balance": {
      "type": "number",
      "description": "balance after transaction was made."
    },
    "transaction_id": {
      "type": "number",
      "description": "Id of transaction"
    },
    "description": {
      "type": "string",
      "description": "Description about transaction"
    }
  },
  "required": [
    "category",
    "transaction_account_id",
    "transaction_type",
    "amount",
    "currency_code",
    "balance",
    "transaction_id",
    "description"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Transaction created."
}

Company All Agreements

Company All Agreements

Company All Agreements
GET/api/v1/agreements/:company-slug:/

Example URI

GET /api/v1/agreements/:company-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "reference_number": "5l7598c42m",
    "annual_interests": "11.0",
    "is_signed": false,
    "collateral_value": 0,
    "created": "2016-06-07T09:18:53.672171Z",
    "currency": "USD",
    "payment_freequency": "Monthly",
    "days_until_penalty": 1,
    "description": "app desc",
    "first_payment_date": "2016-05-17",
    "late_fee_per_day": "0.00",
    "agreement_amount": "5000.00",
    "loan_term": 5,
    "agreement_type": "Auto & Vehicle Loan",
    "modified": "2016-06-07T09:18:56.876614Z",
    "monthly_fee": "12.00",
    "number_of_payments": 5,
    "payment_amount": "1066.96",
    "rate_per_period": "2.20",
    "total_fee": "60.00",
    "total_interest": "334.79",
    "total_payments": "5394.79",
    "is_paid": false,
    "outstanding": 5394.8
  },
  {
    "reference_number": "2t2tsk2aff",
    "annual_interests": "0.0",
    "is_signed": false,
    "collateral_value": 0,
    "created": "2016-05-18T07:36:47.908598Z",
    "currency": "ZAR",
    "payment_freequency": "Weekly",
    "days_until_penalty": 1,
    "description": "",
    "first_payment_date": "2016-05-31",
    "late_fee_per_day": "0.00",
    "agreement_amount": "500.00",
    "loan_term": 12,
    "agreement_type": "Auto & Vehicle Loan",
    "modified": "2016-05-18T07:36:50.824106Z",
    "monthly_fee": "0.00",
    "number_of_payments": 48,
    "payment_amount": "10.42",
    "rate_per_period": "0.00",
    "total_fee": "0.00",
    "total_interest": "0.00",
    "total_payments": "500.00",
    "is_paid": false,
    "outstanding": 500.16000000000025
  },
  {
    "reference_number": "uiwtd7zowj",
    "annual_interests": "12.0",
    "is_signed": true,
    "collateral_value": 0,
    "created": "2016-04-20T05:59:59.910623Z",
    "currency": "USD",
    "payment_freequency": "Monthly",
    "days_until_penalty": 1,
    "description": "education loan",
    "first_payment_date": "2016-04-30",
    "late_fee_per_day": "0.00",
    "agreement_amount": "2300.00",
    "loan_term": 24,
    "agreement_type": "Education Loan",
    "modified": "2016-04-20T06:19:00.013183Z",
    "monthly_fee": "1.00",
    "number_of_payments": 24,
    "payment_amount": "101.94",
    "rate_per_period": "0.50",
    "total_fee": "24.00",
    "total_interest": "146.50",
    "total_payments": "2470.50",
    "is_paid": false,
    "outstanding": 2470.560000000001
  }
]

Company Client's All Agreements

Company Client’s All Agreements

Company Client's All Agreements
GET/api/v1/agreements/company/:company-slug:/client/:client-slug:/

Example URI

GET /api/v1/agreements/company/:company-slug:/client/:client-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "reference_number": "qyheqcapn4",
    "annual_interests": "0.0",
    "is_signed": false,
    "collateral_value": 0,
    "created": "2016-06-20T11:20:55.958806Z",
    "currency": "ZAR",
    "payment_freequency": "Weekly",
    "days_until_penalty": 1,
    "description": "sdfsdf",
    "first_payment_date": "2016-12-12",
    "late_fee_per_day": "0.00",
    "agreement_amount": "2003.00",
    "loan_term": 12,
    "agreement_type": "Home Improvement",
    "modified": "2016-06-20T11:21:00.171542Z",
    "monthly_fee": "0.00",
    "number_of_payments": 48,
    "payment_amount": "41.73",
    "rate_per_period": "0.00",
    "total_fee": "0.00",
    "total_interest": "0.00",
    "total_payments": "2003.00",
    "is_paid": false,
    "outstanding": 2003.0400000000006
  },
  {
    "reference_number": "uiwtd7zowj",
    "annual_interests": "12.0",
    "is_signed": true,
    "collateral_value": 0,
    "created": "2016-04-20T05:59:59.910623Z",
    "currency": "USD",
    "payment_freequency": "Monthly",
    "days_until_penalty": 1,
    "description": "education loan",
    "first_payment_date": "2016-04-30",
    "late_fee_per_day": "0.00",
    "agreement_amount": "2300.00",
    "loan_term": 24,
    "agreement_type": "Education Loan",
    "modified": "2016-04-20T06:19:00.013183Z",
    "monthly_fee": "1.00",
    "number_of_payments": 24,
    "payment_amount": "101.94",
    "rate_per_period": "0.50",
    "total_fee": "24.00",
    "total_interest": "146.50",
    "total_payments": "2470.50",
    "is_paid": false,
    "outstanding": 2367.620000000001
  }
]

Company Client's Single Agreements Details

Company Client’s Single Agreements Details

Company Client's Single Agreements Details
GET/api/v1/agreements/:company-slug:/:agreement-slug:/

Example URI

GET /api/v1/agreements/:company-slug:/:agreement-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "reference_number": "5l7598c42m",
  "annual_interests": "11.0",
  "is_signed": false,
  "collateral_value": 0,
  "created": "2016-06-07T09:18:53.672171Z",
  "currency": "USD",
  "payment_freequency": "Monthly",
  "days_until_penalty": 1,
  "description": "app desc",
  "first_payment_date": "2016-05-17",
  "late_fee_per_day": "0.00",
  "agreement_amount": "5000.00",
  "loan_term": 5,
  "agreement_type": "Auto & Vehicle Loan",
  "modified": "2016-06-07T09:18:56.876614Z",
  "monthly_fee": "12.00",
  "number_of_payments": 5,
  "payment_amount": "1066.96",
  "rate_per_period": "2.20",
  "total_fee": "60.00",
  "total_interest": "334.79",
  "total_payments": "5394.79",
  "is_paid": false,
  "outstanding": 5394.8
}

Company Payments of a Client

Company Payments of a Client

Company Payments of a Client
GET/api/v1/payments/:company-slug:/:client-slug:/

Example URI

GET /api/v1/payments/:company-slug:/:client-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 2345,
    "loan": 17,
    "number": 1,
    "date": "2016-04-30",
    "amount": "102.94",
    "interest": "11.50",
    "principal": "90.44",
    "balance": "2209.56",
    "created": "2016-04-20T06:19:00.032521Z",
    "updated": "2016-06-20T07:49:32.707516Z",
    "status": "paid"
  },
  {
    "id": 2346,
    "loan": 17,
    "number": 2,
    "date": "2016-05-30",
    "amount": "102.94",
    "interest": "11.05",
    "principal": "90.89",
    "balance": "2118.67",
    "created": "2016-04-20T06:19:00.037418Z",
    "updated": "2016-04-20T06:19:00.037458Z",
    "status": "late"
  },
  {
    "id": 2771,
    "loan": 34,
    "number": 4,
    "date": "2017-01-02",
    "amount": "41.73",
    "interest": "0.00",
    "principal": "41.73",
    "balance": "1836.08",
    "created": "2016-06-20T11:21:00.243434Z",
    "updated": "2016-06-20T11:21:00.243502Z",
    "status": null
  }
]

Company Payments of a Client's Agreement

Company Payments of a Client’s Agreement

Company Payments of a Client's Agreement
GET/api/v1/payments/:company-slug:/:client-slug:/:agreement-reference-number:/

Example URI

GET /api/v1/payments/:company-slug:/:client-slug:/:agreement-reference-number:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": 2345,
    "loan": 17,
    "number": 1,
    "date": "2016-04-30",
    "amount": "102.94",
    "interest": "11.50",
    "principal": "90.44",
    "balance": "2209.56",
    "created": "2016-04-20T06:19:00.032521Z",
    "updated": "2016-06-20T07:49:32.707516Z",
    "status": "paid"
  },
  {
    "id": 2346,
    "loan": 17,
    "number": 2,
    "date": "2016-05-30",
    "amount": "102.94",
    "interest": "11.05",
    "principal": "90.89",
    "balance": "2118.67",
    "created": "2016-04-20T06:19:00.037418Z",
    "updated": "2016-04-20T06:19:00.037458Z",
    "status": "late"
  }
]

Company Payments Status Change

Company Payments Status Change

Company Payments Status Change
GET/api/v1/payment/:company:/:payment_id:/:status:/

status: possible values [paid, not_paid]

Example URI

GET /api/v1/payment/:company:/:payment_id:/:status:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Payment status changed to paid/not_paid"
}

Company-Applications-Viewer

Application viewer can only able to view aplications of a specific company.

Company All Applications

Company All Applications

Company All Applications
GET/api/v1/applications/:company-slug:/

Example URI

GET /api/v1/applications/:company-slug:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "profile_picture_url": "/api/v1/applications/ke8zyjde98/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/ke8zyjde98/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/ke8zyjde98/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/ke8zyjde98/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/ke8zyjde98/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "ke8zyjde98",
    "client_company_phone": "+91-9440736864",
    "account_number": "",
    "gender": "male",
    "marital_status": "divorced",
    "dependents": "0",
    "date_of_birth": "2016-04-11",
    "job_title": "sw",
    "employer": "mp",
    "employee_id": "12345",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "unreviewed",
    "created": "2016-04-21T11:05:25.954431Z",
    "updated": "2016-04-21T11:05:25.954470Z",
    "worked_months": 30,
    "first_name": "ravi",
    "last_name": "kumar",
    "phone_number": "+91-9440736864",
    "client_type": "natural_person",
    "ssn": "12345",
    "company_no": null,
    "address": "hig499",
    "street": "",
    "city": "",
    "state": "",
    "postal_code": "",
    "monthly_income": "4.00",
    "monthly_expenses": "0.00",
    "balance": "0.00",
    "customer_notes": null,
    "email": "ravi@mp.com",
    "account_name": "Simple account 1 MasterCard",
    "bank_name": "Fake Bank Simple",
    "routing_number": "fakebank_simple_xf",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Home Improvement",
    "loan_description": null,
    "agreement_amount": "2000.00",
    "currency": "USD",
    "loan_term": 12,
    "first_payment_date": "2016-04-18",
    "licence_number": null,
    "dlicence_expiry": "2016-05-11"
  },
  {
    "profile_picture_url": "/api/v1/applications/5fqzt4cxha/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/5fqzt4cxha/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/5fqzt4cxha/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/5fqzt4cxha/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/5fqzt4cxha/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "5fqzt4cxha",
    "client_company_phone": "+27-118984342",
    "account_number": "",
    "gender": "male",
    "marital_status": "single",
    "dependents": "0",
    "date_of_birth": "1983-06-28",
    "job_title": "Manager",
    "employer": "Creditable",
    "employee_id": "101",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "approved",
    "created": "2016-05-11T10:10:51.330825Z",
    "updated": "2016-05-18T07:36:48.321201Z",
    "worked_months": 48,
    "first_name": "Sechaba",
    "last_name": "Ngwenya",
    "phone_number": "+27-817424321",
    "client_type": "natural_person",
    "ssn": "8306285151081",
    "company_no": null,
    "address": "Dunkeld Corner, 275 Jan Smuts Avenue",
    "street": "",
    "city": "",
    "state": "",
    "postal_code": "",
    "monthly_income": "0.00",
    "monthly_expenses": "0.00",
    "balance": "0.00",
    "customer_notes": null,
    "email": "sechabangwenya+crd@gmail.com",
    "account_name": "Simple account 1 MasterCard",
    "bank_name": "Fake Bank Simple",
    "routing_number": "fakebank_simple_xf",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Auto & Vehicle Loan",
    "loan_description": null,
    "agreement_amount": "500.00",
    "currency": "USD",
    "loan_term": 12,
    "first_payment_date": "2016-05-31",
    "licence_number": null,
    "dlicence_expiry": "2016-05-11"
  },
  {
    "profile_picture_url": "/api/v1/applications/r9ls486r5a/profile-picture/download/",
    "id_proof_url": "/api/v1/applications/r9ls486r5a/id-proof/download/",
    "utility_bill_url": "/api/v1/applications/r9ls486r5a/utility-bill/download/",
    "pay_slip_url": "/api/v1/applications/r9ls486r5a/pay-slip/download/",
    "bank_statement_url": "/api/v1/applications/r9ls486r5a/bank-statement/download/",
    "payment_freequency": "Monthly",
    "reference_number": "r9ls486r5a",
    "client_company_phone": "+27 9874563210",
    "account_number": "",
    "gender": "male",
    "marital_status": "married",
    "dependents": "0",
    "date_of_birth": "2016-06-29",
    "job_title": "dev",
    "employer": "hello",
    "employee_id": "emp112",
    "date_of_incorporation": null,
    "name_of_contact": null,
    "number_of_employees": null,
    "status": "approved",
    "created": "2016-06-01T07:34:59.273348Z",
    "updated": "2016-06-03T08:17:51.128498Z",
    "worked_months": 12,
    "first_name": "rak",
    "last_name": "p",
    "phone_number": "+27 9874563210",
    "client_type": "natural_person",
    "ssn": "112233",
    "company_no": null,
    "address": "w",
    "street": "w",
    "city": "w",
    "state": "w",
    "postal_code": "w",
    "monthly_income": "24.36",
    "monthly_expenses": "14.00",
    "balance": "2010.10",
    "customer_notes": null,
    "email": "ww@ww.cd",
    "account_name": "Oauth account 2",
    "bank_name": "Fake Bank OAuth",
    "routing_number": "fakebank_oauth_xf",
    "iban": "",
    "bank_acc_name": "",
    "agreement_type": "Auto & Vehicle Loan",
    "loan_description": null,
    "agreement_amount": "220.00",
    "currency": "ZAR",
    "loan_term": 22,
    "first_payment_date": "2016-06-22",
    "licence_number": "12365",
    "dlicence_expiry": "2016-06-18"
  }
]

Company Application Details

Company Application Details

Company Application Details
GET/api/v1/applications/:company-slug:/:application-reference-number:/

Example URI

GET /api/v1/applications/:company-slug:/:application-reference-number:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "profile_picture_url": "/api/v1/applications/f35gn38czg/profile-picture/download/",
  "id_proof_url": "/api/v1/applications/f35gn38czg/id-proof/download/",
  "utility_bill_url": "/api/v1/applications/f35gn38czg/utility-bill/download/",
  "pay_slip_url": "/api/v1/applications/f35gn38czg/pay-slip/download/",
  "bank_statement_url": "/api/v1/applications/f35gn38czg/bank-statement/download/",
  "payment_freequency": "Monthly",
  "reference_number": "f35gn38czg",
  "client_company_phone": "+27 9887465521",
  "account_number": "123456",
  "gender": "male",
  "marital_status": null,
  "dependents": "0",
  "date_of_birth": "1995-06-12",
  "job_title": null,
  "employer": null,
  "employee_id": null,
  "date_of_incorporation": null,
  "name_of_contact": null,
  "number_of_employees": null,
  "status": "approved",
  "created": "2016-06-14T08:25:53.095127Z",
  "updated": "2016-06-15T07:42:50.788710Z",
  "worked_months": 12,
  "first_name": "shera",
  "last_name": "s",
  "phone_number": "+27 9874563210",
  "client_type": "natural_person",
  "ssn": null,
  "company_no": null,
  "address": "hyd",
  "street": "sdfsd",
  "city": "hyd",
  "state": "tel",
  "postal_code": "12313",
  "monthly_income": "1680.00",
  "monthly_expenses": "-90.00",
  "balance": "0.00",
  "customer_notes": null,
  "email": "anjaneyulu.test@gmail.com",
  "account_name": "anji123",
  "bank_name": "bank of baroda",
  "routing_number": "abcd12",
  "iban": "",
  "bank_acc_name": "",
  "agreement_type": "Home Improvement",
  "loan_description": null,
  "agreement_amount": "200.00",
  "currency": "ZAR",
  "loan_term": 12,
  "first_payment_date": "2016-11-11",
  "licence_number": null,
  "dlicence_expiry": null
}

Company Download Document of an Application

Company Download Document of an Application

Company Download Document of an Application
GET/api/v1/applications/:reference-number:/:document-slug:/download/

document-slug: possible values [profile-picture, id-proof, utility-bill, bank-statement, pay-slip]

Example URI

GET /api/v1/applications/:reference-number:/:document-slug:/download/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: file
Body
requested document will be downloaded

All-Applications-Viewer

All applications viewer can view all applications in the creditable

All applications

All applications

All applications
GET/api/v1/all-applications/

Example URI

GET /api/v1/all-applications/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
    {
        "profile_picture_url": "/api/v1/applications/0ynyr332md/profile-picture/download/",
        "id_proof_url": "/api/v1/applications/0ynyr332md/id-proof/download/",
        "utility_bill_url": "/api/v1/applications/0ynyr332md/utility-bill/download/",
        "pay_slip_url": "/api/v1/applications/0ynyr332md/pay-slip/download/",
        "bank_statement_url": "/api/v1/applications/0ynyr332md/bank-statement/download/",
        "payment_freequency": "Monthly",
        "reference_number": "0ynyr332md",
        "client_company_phone": "+85291295051",
        "account_number": "4366789",
        "gender": "male",
        "marital_status": "divorced",
        "dependents": null,
        "date_of_birth": "1995-09-11",
        "job_title": "Manager",
        "employer": "Tofupay",
        "employee_id": "1234",
        "date_of_incorporation": null,
        "name_of_contact": null,
        "number_of_employees": null,
        "status": "approved",
        "created": "2015-09-18T06:16:38.135482Z",
        "updated": "2015-09-18T06:22:13.723609Z",
        "worked_months": 0,
        "first_name": "Anthony",
        "last_name": "Fitoussi",
        "phone_number": "+85291295051",
        "client_type": "natural_person",
        "ssn": "6789DEF",
        "company_no": null,
        "address": "FER12345",
        "street": "",
        "city": "",
        "state": "",
        "postal_code": "",
        "monthly_income": "7000.00",
        "monthly_expenses": "3000.00",
        "balance": null,
        "customer_notes": "",
        "email": "anthony@tofupay.com",
        "account_name": "fake bank",
        "bank_name": "ANZ Hong Kong",
        "routing_number": "234567",
        "iban": "",
        "bank_acc_name": "",
        "agreement_type": "Auto & Vehicle Loan",
        "loan_description": "",
        "agreement_amount": "300.00",
        "currency": "USD",
        "loan_term": 50,
        "first_payment_date": "2015-09-21",
        "licence_number": null,
        "dlicence_expiry": "2016-05-11",
    },
    {
        "profile_picture_url": "/api/v1/applications/zcpw7ncbne/profile-picture/download/",
        "id_proof_url": "/api/v1/applications/zcpw7ncbne/id-proof/download/",
        "utility_bill_url": "/api/v1/applications/zcpw7ncbne/utility-bill/download/",
        "pay_slip_url": "/api/v1/applications/zcpw7ncbne/pay-slip/download/",
        "bank_statement_url": "/api/v1/applications/zcpw7ncbne/bank-statement/download/",
        "payment_freequency": "Monthly",
        "reference_number": "zcpw7ncbne",
        "client_company_phone": "123564",
        "account_number": "59255225",
        "gender": "male",
        "marital_status": "married",
        "dependents": null,
        "date_of_birth": "2015-08-04",
        "job_title": "se",
        "employer": "micropyramid",
        "employee_id": "123",
        "date_of_incorporation": null,
        "name_of_contact": null,
        "number_of_employees": null,
        "status": "approved",
        "created": "2015-09-18T05:57:22.797888Z",
        "updated": "2015-09-18T06:31:34.081670Z",
        "worked_months": 0,
        "first_name": "Test",
        "last_name": "Test",
        "phone_number": "+919440736864",
        "client_type": "natural_person",
        "ssn": "12345",
        "company_no": null,
        "address": "KPHB 6th Phase",
        "street": "",
        "city": "",
        "state": "",
        "postal_code": "",
        "monthly_income": "40.00",
        "monthly_expenses": "20.00",
        "balance": null,
        "customer_notes": "",
        "email": "ravikumar.gadila@gmail.com",
        "account_name": "Simple account 2",
        "bank_name": "Fake Bank Simple",
        "routing_number": "fakebank_simple_xf",
        "iban": "",
        "bank_acc_name": "",
        "agreement_type": "Auto & Vehicle Loan",
        "loan_description": "",
        "agreement_amount": "500.00",
        "currency": "INR",
        "loan_term": 20,
        "first_payment_date": "2015-09-30",
        "licence_number": null,
        "dlicence_expiry": "2016-05-11"
    }
]

Application Details

Application Details

Application Details
GET/api/v1/applications/:company-slug:/:application-reference-number:/

Example URI

GET /api/v1/applications/:company-slug:/:application-reference-number:/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "profile_picture_url": "/api/v1/applications/f35gn38czg/profile-picture/download/",
  "id_proof_url": "/api/v1/applications/f35gn38czg/id-proof/download/",
  "utility_bill_url": "/api/v1/applications/f35gn38czg/utility-bill/download/",
  "pay_slip_url": "/api/v1/applications/f35gn38czg/pay-slip/download/",
  "bank_statement_url": "/api/v1/applications/f35gn38czg/bank-statement/download/",
  "payment_freequency": "Monthly",
  "reference_number": "f35gn38czg",
  "client_company_phone": "+27 9887465521",
  "account_number": "123456",
  "gender": "male",
  "marital_status": null,
  "dependents": "0",
  "date_of_birth": "1995-06-12",
  "job_title": null,
  "employer": null,
  "employee_id": null,
  "date_of_incorporation": null,
  "name_of_contact": null,
  "number_of_employees": null,
  "status": "approved",
  "created": "2016-06-14T08:25:53.095127Z",
  "updated": "2016-06-15T07:42:50.788710Z",
  "worked_months": 12,
  "first_name": "shera",
  "last_name": "s",
  "phone_number": "+27 9874563210",
  "client_type": "natural_person",
  "ssn": null,
  "company_no": null,
  "address": "hyd",
  "street": "sdfsd",
  "city": "hyd",
  "state": "tel",
  "postal_code": "12313",
  "monthly_income": "1680.00",
  "monthly_expenses": "-90.00",
  "balance": "0.00",
  "customer_notes": null,
  "email": "anjaneyulu.test@gmail.com",
  "account_name": "anji123",
  "bank_name": "bank of baroda",
  "routing_number": "abcd12",
  "iban": "",
  "bank_acc_name": "",
  "agreement_type": "Home Improvement",
  "loan_description": null,
  "agreement_amount": "200.00",
  "currency": "ZAR",
  "loan_term": 12,
  "first_payment_date": "2016-11-11",
  "licence_number": null,
  "dlicence_expiry": null
}

Download Document of an Application

Download Document of an Application

Download Document of an Application
GET/api/v1/applications/:reference-number:/:document-slug:/download/

document-slug: possible values [profile-picture, id-proof, utility-bill, bank-statement, pay-slip]

Example URI

GET /api/v1/applications/:reference-number:/:document-slug:/download/
Request
HideShow
Headers
Accept: application/json
Authorization: Token <token-value>
Response  200
HideShow
Headers
Content-Type: file
Body
Requested document will be downloaded

Generated by aglio on 08 Aug 2016