Skip to main content

Financing API (v1)

Download OpenAPI specification:Download

Lenders

Retrieve a list of lenders

Authorizations:
bearer
query Parameters
page
integer <int32>
Default: 1

Page number to retrieve (optional) (defaults to 1)

pageSize
integer <int32>
Default: 50

Number of results to retrieve per page (optional) (defaults to 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "_pagination": {
    }
}

FinancingApplications

Retrieve a list of financing applications

Authorizations:
bearer
query Parameters
page
integer <int32>
Default: 1

Page number to retrieve (optional) (defaults to 1)

pageSize
integer <int32>
Default: 50

Number of results to retrieve per page (optional) (defaults to 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "_pagination": {
    }
}

Create a new financing application

Authorizations:
bearer
Request Body schema: application/json
required

The financing application to create

lenderKey
required
string

The key of the lender selected for this application.

investmentAmount
required
number <decimal>

The amount requested for financing.

investmentCurrency
required
string

The ISO 4217 currency of the investment amount.

required
FinancingPurpose (string)

The purpose of the requested financing.

purposeDescription
required
string

The additional description of the financing purpose.

required
FinancingCommunication (string)

The parties with whom application communication is shared.

required
FinancingCompany (object)

The company applying for financing.

required
FinancingApplicant (object)

The applicant's contact information.

required
FinancingAdvisor (object)

The advisor's contact information.

required
Array of objects (FinancingAccount)

The EnableNow accounts.

Responses

Request samples

Content type
application/json
{
  • "lenderKey": "string",
  • "investmentAmount": 0,
  • "investmentCurrency": "string",
  • "purpose": "WorkingCapital",
  • "purposeDescription": "string",
  • "communication": "None",
  • "company": {
    },
  • "applicant": {
    },
  • "advisor": {
    },
  • "accounts": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "lenderKey": "string",
  • "status": "Draft",
  • "investmentAmount": 0,
  • "investmentCurrency": "string",
  • "purpose": "WorkingCapital",
  • "purposeDescription": "string",
  • "communication": "None",
  • "company": {
    },
  • "applicant": {
    },
  • "advisor": {
    },
  • "accounts": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Retrieve a financing application by its identifier

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lenderKey": "string",
  • "status": "Draft",
  • "investmentAmount": 0,
  • "investmentCurrency": "string",
  • "purpose": "WorkingCapital",
  • "purposeDescription": "string",
  • "communication": "None",
  • "company": {
    },
  • "applicant": {
    },
  • "advisor": {
    },
  • "accounts": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Retrieve documents attached to a financing application

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attach a document to a financing application

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

Request Body schema: multipart/form-data
File
string or null <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fileName": "string",
  • "contentType": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Delete a document attached to a financing application

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

documentId
required
string <guid>

The unique identifier of the document

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "traceId": "string",
  • "errors": {
    }
}

Submit a financing application for processing

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lenderKey": "string",
  • "status": "Draft",
  • "investmentAmount": 0,
  • "investmentCurrency": "string",
  • "purpose": "WorkingCapital",
  • "purposeDescription": "string",
  • "communication": "None",
  • "company": {
    },
  • "applicant": {
    },
  • "advisor": {
    },
  • "accounts": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Approve a financing application

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lenderKey": "string",
  • "status": "Draft",
  • "investmentAmount": 0,
  • "investmentCurrency": "string",
  • "purpose": "WorkingCapital",
  • "purposeDescription": "string",
  • "communication": "None",
  • "company": {
    },
  • "applicant": {
    },
  • "advisor": {
    },
  • "accounts": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z"
}

Reject a financing application

Authorizations:
bearer
path Parameters
id
required
string <guid>

The unique identifier of the financing application

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lenderKey": "string",
  • "status": "Draft",
  • "investmentAmount": 0,
  • "investmentCurrency": "string",
  • "purpose": "WorkingCapital",
  • "purposeDescription": "string",
  • "communication": "None",
  • "company": {
    },
  • "applicant": {
    },
  • "advisor": {
    },
  • "accounts": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z"
}