latestOpenAPI 3.0.02026-08-133383136.3 KB

fc4f4dd68f9b

Onboarding

Send Loan Agreement

post/v1/onboarding/send-agreement

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

Request body

customerReferenceNostring required

Customer Reference Number of company/business assigned by the platform to uniquely identify the customer. It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand and forward slash.

  • /(^[a-zA-Z0-9#/-]+)$/

Example request

{
  "customerReferenceNo": "c3eb1619-ff24-4773-97d8-b05264621e60"
}

Response

Email sent

statusCodenumber required

The HTTP status code of the error

datastring required

Agreent sent status of application.

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response