Lender Submission API

Assumptions

• Desired lenders for submission are already available in the account
• Lender maintains an external system that handles and processes submissions. This system is capable of listening for HTTP webhooks and can connect to an OAuth 2.0 JSON API
• Lender is able, understanding and willing to perform an integration with the CTX API

HMAC Webhooks

• HMAC or Hash-based Message Authentication Code is a set of headers that are added to a webhook to secure it in transit from an origin to a destination system (IETF RFC 2104)
• HMAC works by having a shared secret between the origin and destination systems. This secret is hashed using SHA1 and SHA256 added as two separate headers to support a wide variety of use cases. The same cryptographic algorithms are used on the origin and destination systems on the common shared secret and the hashes are compared to ensure security.

Lender Submission Setup

• Find the tab named “Submissions” under the lender details view
• Submission Methods – Email or API
  • Only one method may be selected per lender
  • If API method is selected, a dropdown lists all available webhooks with HMAC enabled as a searchable dropdown. This is the webhook that will fire when this lender receives a submission.
  • Only one webhook can be selected to fire per lender. To configure or modify this webhook the user must use the webhook management page.
  • Available Data Fields
    • This dropdown allows the user to select the specific fields they want shared with the lender  

Lender Submission Process

The webhook configured on each lender via the lender details page will fire. The webhook payload will be as follows:

{
  "lender_id" : "12123123", //Lender ID
  "submission_id" : "1858589585", //Unique Submission ID
  "advance_id" : "8128381", //Advance ID
  "timestamp": "1669102195" //Unix Timestamp
}

Base URL

https://api.centrexsoftware.com/v1

Get Submission

GET

/lenders/{lender_id}/{advance_id}/{submission_id}

{
  "response": {
      "object": "loanSubmission",
      "id": "9067307",
      "acctID": "511",
      "created_at": "2023-02-24 09:40:23",
      "created_by": "346276",
      "lender_id": "46682",
      "emails": [
          ""
      ],
      "notes": null,
      "status_id": "2",
      "status_date": "2023-02-24",
      "method": "api",
      "resubmit": "0",
      "counter_offer": null,
      "counter_offer_accepted": null,
      "fields": {
          "Business Name": "Lesch, Waelchi and Wuckert",
          "Cell Phone": "(386) 8674574",
          "Email": "paughtonrb@java.com",
          "First Name": "Priscilla",
      },
      "contact_id": "379957591",
      "documents": [
          {
              "filename": "XXX.pdf",
              "title": "Bizloan Application.pdf",
              "acctID": "511",
              "contact_id": "379957591",
              "url": "XXXXX"
  "status": {
      "code": 200
  }
}

Get Submission Status

GET

/lenders/submissions/statuses

{
  "response": [
      {
          "id": "2",
          "title": "Submitted"
      },
      {
          "id": "4",
          "title": "Cond Approved"
      },
      {
          "id": "6",
          "title": "Approved"
      },
      {
          "id": "8",
          "title": "Declined"
      },
      {
          "id": "10",
          "title": "Rejected / Correct"
      },
      {
          "id": "12",
          "title": "Funded"
      },
      {
          "id": "24",
          "title": "Does Not Qualify"
      },
      {
          "id": "25",
          "title": "Error"
      },
      {
          "id": "32",
          "title": "Prequalified"
      },
      {
          "id": "35",
          "title": "Prequal Rejected"
      }
  ],
  "status": {
      "code": 200
  }
}

Update Submission Status

PUT

/lenders/{lender_id}/{advance_id}/{submission_id}

Request Body:

{
  "status_id": "1"
}