Skip to main content
POST
/
api
/
application-trigger
Trigger an application from an external system
curl --request POST \
  --url https://your-instance.example.com/api/application-trigger \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "name": "<string>",
  "status": "<string>",
  "description": "<string>",
  "notes": "<string>",
  "amount": 123,
  "loanType": "<string>",
  "applicationDate": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "application": {},
    "contact": {
      "id": "<string>",
      "phoneNumber": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phoneNumber
string
required
firstName
string
required
lastName
string
required
name
string
required

Application name

status
string
required

Application status

description
string
notes
string
amount
number
loanType
string
applicationDate
string

Response

Application received successfully

success
boolean
message
string
data
object