Proposal Securities v2

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

proposal ID status:REQUIRED
integer - ID of your chosen proposal

Proposal Securities Requests status:GEt status:Post

status:Get status:Post - Return all securities for a proposal or add a new security to a proposal

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/proposals/{id}/securities/

Example Payload status:POSt

{
    "description":"This is a note I am adding to a proposal",
    "type": "Second Charge"
}

Response

status:200
Returned if the request is successful.

{
    "items": [
        {
            "security_id": 1001,
            "description": "This is a security I am adding to a proposal",
            "type": "First Charge",
            "expiry_date": null,
            "value": null,
            "creation_date": "2022-08-19 10:33:59",
            "created_by": "Joe Bloggs"
        }
    ]
}

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

Proposal Securities Attributes

When adding a new Proposal Security via the API, there are a number of fields needed.

Mandatory Fields

description - string
Max length 1000 characters

type - string
Must be a security type already configured in Accelerate

Non Mandatory Fields

security_id - number
Must not be supplied when using status:post

expiry_date - date

value - number
Leave null for an unlimited guarantee

amount - number
Leave null for an unlimited guarantee

property_value - number
Value of property owned by the guarantor

mortgage_outstanding - number
Mortgage outstanding on property owned by the guarantor

comments - string
Max length 4000

QV Systems Knowledge Base