Get Pre-Approval Offer
Retrieve pre-approval offers and qualification status for a specific application/lead.
Endpoint
Staging
POST https://missioncapital--full.sandbox.my.salesforce.com/services/apexrest/creditapp/getPreApprovalOffer
Production
POST https://missioncapital.my.salesforce.com/services/apexrest/creditapp/getPreApprovalOffer
Headers
| Header | Value |
|---|---|
| Authorization | Bearer YOUR_ACCESS_TOKEN |
| Content-Type | application/json |
| PartnerId | YOUR_PARTNER_ID |
| PartnerName | YOUR_PARTNER_NAME |
| ApplicationID | SALESFORCE_LEAD_ID |
Request Body
This endpoint does not require a request body. All necessary information is provided in the headers.
Sample Request
POST https://missioncapital--full.sandbox.my.salesforce.com/services/apexrest/creditapp/getPreApprovalOffer
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
PartnerId: YOUR_PARTNER_ID
PartnerName: YOUR_PARTNER_NAME
ApplicationID: 00QEa00000ItVf8MAF
Note: This endpoint does not require a JSON request body. All necessary information is provided in the headers.
Sample Response
Qualified with Offers
{
"IsSuccessful": true,
"ResponseText": "Application found",
"ReferenceID": "partner-lead-12345",
"pURL": "https://sbgfunding.com/apply-now/?leadid=00QEa00000ItVf8",
"PreApproval_Data": {
"PreApproval_Status": "Qualified",
"PreApproval_Offers": [
{
"OfferId": "a1X8c000000fxY4EAI",
"Product": "Business Term Loan",
"Loan_Amount": 75000,
"Est_Term": 24,
"Payment_Frequency": "Monthly",
"Est_Payment_Amount": 3750.50,
"Monthly_Rate": 1.25,
"APR_Range_Low": 18.5,
"APR_Range_High": 24.5,
"Fee_Range_Low": 2500,
"Fee_Range_High": 3500,
"Funding_Disclosures": "Approval subject to final underwriting review",
"Total_Cost_of_Loan": 90012.00,
"Cents_on_the_Dollar": 1.20,
"Total_Interest_Cost": 15012.00
}
]
}
}
Not Qualified
{
"IsSuccessful": true,
"ResponseText": "Application found",
"ReferenceID": "partner-lead-12345",
"pURL": "https://sbgfunding.com/apply-now/?leadid=00QEa00000ItVf8",
"PreApproval_Data": {
"PreApproval_Status": "Not Qualified",
"PreApproval_Offers": []
}
}
Qualified but No Offers Yet
{
"IsSuccessful": true,
"ResponseText": "No Related Pre Approval Offers Created yet",
"ReferenceID": "partner-lead-12345",
"pURL": "https://sbgfunding.com/apply-now/?leadid=00QEa00000ItVf8",
"PreApproval_Data": {
"PreApproval_Status": "Qualified",
"PreApproval_Offers": []
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
| IsSuccessful | boolean | Whether the request was successful |
| ResponseText | string | Human-readable response message |
| ReferenceID | string | Your original application reference ID |
| pURL | string | Application tracking URL |
| PreApproval_Data | object | Pre-approval qualification and offers data |
PreApproval_Data Object
| Field | Type | Description |
|---|---|---|
| PreApproval_Status | string | Qualification status: "Qualified", "Not Qualified" |
| PreApproval_Offers | array | Array of available pre-approval offers |
PreApproval_Offers Array Items
| Field | Type | Description |
|---|---|---|
| OfferId | string | Unique identifier for the offer |
| Product | string | Type of loan product |
| Loan_Amount | number | Approved loan amount |
| Est_Term | number | Estimated term in months |
| Payment_Frequency | string | Payment frequency (e.g., "Monthly") |
| Est_Payment_Amount | number | Estimated payment amount |
| Monthly_Rate | number | Monthly rate percentage |
| APR_Range_Low | number | Lower bound of APR range |
| APR_Range_High | number | Upper bound of APR range |
| Fee_Range_Low | number | Lower bound of fee range |
| Fee_Range_High | number | Upper bound of fee range |
| Funding_Disclosures | string | Important disclosures about the offer |
| Total_Cost_of_Loan | number | Total cost including principal and interest |
| Cents_on_the_Dollar | number | Cost per dollar borrowed |
| Total_Interest_Cost | number | Total interest cost over loan term |
Error Scenarios
Common error responses include:
- Missing ApplicationID:
"Missing Application ID" - Invalid ApplicationID:
"Invalid Application ID" - Application not found:
"Application not found" - Invalid authentication:
"Invalid username and password" - Missing headers:
"Invalid Request Header. PartnerName or PartnerId parameters are missing."
Integration Notes
- ApplicationID Required - The
ApplicationIDheader must contain a valid Salesforce Lead ID - Authentication Required - Ensure your Bearer token, PartnerId, and PartnerName are valid
- Feature Enablement - This endpoint is accessible to all partners, but pre-approval offers must be enabled by our support team before you will receive actual offer data for your applications
- Real-time Data - This endpoint returns the most current pre-approval status and offers
- Multiple Offers - An application may have multiple pre-approval offers with different terms
Use Cases
This endpoint is useful when:
- You want to check if an application has been pre-approved
- You need to display available loan offers to the applicant
- You want to integrate pre-approval status into your application flow
- You need to show specific loan terms and pricing to prospects