{"info":{"_postman_id":"b8a13d35-c42f-400b-8c1f-e0700754d2a9","name":"MKIII","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"31645010","collectionId":"b8a13d35-c42f-400b-8c1f-e0700754d2a9","publishedId":"2sA3kYjzuA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-26T17:58:24.000Z"},"item":[{"name":"MKIII REST API","item":[{"name":"V1","item":[{"name":"/publisher/application","id":"1251037f-8c24-4266-b80d-e1ad61ddfd28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"applicant\": {\n \"firstName\": \"tester\",\n \"lastName\": \"testerson\",\n \"ssn\": \"123456789\",\n \"dob\": \"1979-11-19\",\n \"phone\": \"9713407422\",\n \"email\": \"tester@testerson.com\",\n \"addressLineOne\": \"123 test St\",\n \"addressLineTwo\": \"Apt X\",\n \"city\": \"Jones\",\n \"state\": \"CO\",\n \"zip\": \"98748\",\n \"annualPreTaxIncome\": 500000.00,\n \"disclosuresAcceptedAt\": \"2024-01-30T02:36:32.329Z\",\n \"employerName\": \"job\",\n \"employmentPosition\": \"worker\",\n \"employmentStartDate\": \"1979-07\",\n \"idVerified\": true\n },\n \"institutionName\": \"usalliance\",\n \"requestedAmount\": 6500.00\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/publisher/application","description":"

Initiates an MKIII loan application with the minimum required customer data.

Request

✅ = Required

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Sub-field	Type	Description
`requestedAmount`✅		`float` (Up to 2 decimal places)	The amount of money the applicant is requesting to borrow in dollars and cents.
`institutionName`		`string`	The lender who would be financing the loan.
`externalId`		`string`	The client specified external ID of the loan application. Can be anything intended to identify the request from the client consumer side
`loanPurpose`		`number`	Optional: if passing loan purpose, must pass the numerical ID value from the enum below `debt_consolidation = 1, payoff_credit_cards = 2, large_purchase = 3, medical_debt = 4, home_improvement = 5, vacation_expenses = 6, moving_expenses = 7, family_or_life_event = 8, taxes = 9, other = 10`
`applicant`✅		`object`	PII of the customer applying for the loan.
	`firstName`✅	`string`	Applicant first name
	`lastName`✅	`string`	Applicant last name
	`ssn`✅	`string`	Applicant ssn, which is encrypted and stored separately away from other customer PII for extra security.
	`dob`✅	`string` (Date format YYYY-MM-DD i.e. 1985-07-03)	Applicant date of birth
	`phone`✅	`string`	Applicant 10-digit phone number. Must be a US number.
	`email`✅	`string`	Applicant email
	`addressLineOne`✅	`string`	Applicant address line one
	`addressLineTwo`	`string`	Applicant optional address line two
	`city`✅	`string`	Applicant city
	`state`✅	`string`	Applicant state
	`zip`✅	`string`	Applicant zip code
	`annualPreTaxIncome`✅	`float` (Up to 2 decimal places if there are cents)	Applicant annual income before taxes in dollars and cents.
	`disclosuresAcceptedAt`✅	`string` (ISO8601 timestamp)	Timestamp of when the user accepted the terms of this application submission.
	`employerName`	`string`	Name of applicant's employer
	`employmentPosition`	`string`	Applicant's employment position or title
	`employmentStartDate`	`string` (Date in format YYYY-MM i.e. 1985-07)	Month and year applicant started their current position
	`housingStatus`	`string` (Must be 'Own', 'Rent', or 'Other')	Applicant housing status
	`monthlyHousingCost`	`integer`	Cost of applicant's living situation
	`mlaFlag`	`boolean`	Applicant MLA eligibility
	`creditDetails`	`JSON`	Optional extra credit details if available
	`idVerified`	`boolean`	Applicant's IDV status if IDV already preformed.
	`idImages`	`string[]`(Must be list of valid Base64 encoded images)	Applicant's ID images if IDV already preformed
	`bureau`	`string`	Credit Bureau source of the applicant's pre-screen

Special Notes:

If institutionName is not present the institution will be chosen for the applicant based on a best match criteria.
\n
While annualPreTaxIncome is required, employerName, employmentPosition, and employmentStartDate are not. However if these three employer fields are not available to be sent with the request the applicant will not be fully evaluated until employment info is collected in the MKIII onboarding.
\n
housingStatus will default to 'Rent' if not available.
\n
monthlyHousingCost will default to 500 if not available.
\n
If the optional field idVerified is passed explicitly as false the applicant will be denied.
\n

Minimal Example Request Body

{\n  \"requestedAmount\": 5500.00,\n  \"institutionName\": \"allstarlender\",\n  \"applicant\": {\n    \"firstName\": \"testing\",\n    \"lastName\": \"tester\",\n    \"ssn\": \"123456789\",\n    \"dob\": \"1979-11-19\",\n    \"phone\": \"1231231234\",\n    \"email\": \"testing@tester.com\",\n    \"addressLineOne\": \"123 test St\",\n    \"addressLineTwo\": \"Apt X\",\n    \"city\": \"Jones\",\n    \"state\": \"CO\",\n    \"zip\": \"98765\",\n    \"annualPreTaxIncome\": 65000.00,\n    \"employerName\": \"job\",\n    \"employmentPosition\": \"worker\",\n    \"employmentStartDate\": \"1979-07\",\n    \"disclosuresAcceptedAt\": \"2024-01-30T02:36:32.329Z\",\n    \"idVerified\": true\n  }\n}\n\n

Response

Field	Sub-field	Type	Description
`id`		`string`	The MKIII internal ID of the loan application.
`requestId`		`string`	Unique identifier to this specific HTTP request
`externalId`		`string`	The client specified external ID of the loan application. Will not be returned unless specified in the initial request
`institutionName`		`string`	The lender of the loan application.
`continuationUrl`		`string`	The URL to the MKIII web-app where the applicant can finish their application.
`approvedLoanOffers`		`array[offer]`	The list of potential offers for this applicant.
	`offer.institutionName`	`string`	The lender of the loan offer.
	`offer.loanAmount`	`float`	The amount of the loan in dollars.
	`offer.termInMonths`	`integer`	The term of the loan in months.
	`offer.interestRateInBasisPoints`	`integer`	The interest rate of the loan in basis points, i.e. 5% = 500 basis points.
	`offer.financeCharge`	`float`	The finance charge to the loan in dollars if applicable.
	`offer.monthlyPayment`	`float`	The estimated monthly payment of the loan in dollars.
	`offer.finalPayment`	`float`	The estimated final payment of the loan in dollars.
	`offer.totalPayments`	`float`	The estimated total cost of the loan + interest + fees in dollars.
	`offer.originationDate`	`string` (Date format YYYY-MM-DD)	The date of origination.
	`offer.firstPaymentDate`	`string` (Date format YYYY-MM-DD)	The date of the first payment.
	`offer.finalPaymentDate`	`string` (Date format YYYY-MM-DD)	The date of the final payment. Date format: YYYY-MM-DD.
	`offer.originationFee`	`float`	The fee to originate the loan in dollars if applicable.
	`offer.aprInBasisPoints`	`integer`	The APR of the loan in basis points, i.e. 5% = 500 basis points.
	`offer.continuationUrl`	`string`	The same as `continuationUrl` above, however following a continuation url on an offer, will preselect that offer as the chosen offer, and skip offer selection during onboarding.

{\n  \"id\": \"LAP_01J3NW50RR3REJJTD643GWPY78\",\n  \"requestId\": \"01J3NW50NKW8BM5EQ7GNZB9BQJ\",\n  \"institutionName\": \"allstarlender\",\n  \"approvedLoanOffers\": [\n    {\n      \"institutionName\": \"allstarlender\",\n      \"loanAmount\": 6500,\n      \"termInMonths\": 12,\n      \"interestRateInBasisPoints\": 1224,\n      \"financeCharge\": 471.52,\n      \"monthlyPayment\": 580.97,\n      \"finalPayment\": 580.85,\n      \"totalPayments\": 6971.52,\n      \"firstPaymentDate\": \"2024-09-16\",\n      \"originationDate\": \"2024-08-02\",\n      \"finalPaymentDate\": \"2025-08-16\",\n      \"originationFee\": 0,\n      \"aprInBasisPoints\": 1222.8,\n      \"continuationUrl\": \"https://lender.embed.mkiii.dev/application/continue?ct=96f1a294-c776-4585-971b-6fd3d4c303e9&cs=offer&term=12\"\n    }\n  ],\n  \"continuationUrl\": \"https://lender.embed.mkiii.dev/application/continue?ct=96f1a294-c776-4585-971b-6fd3d4c303e9&cs=offer\"\n}\n\n

\n","urlObject":{"path":["v1","publisher","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1251037f-8c24-4266-b80d-e1ad61ddfd28"},{"name":"/smb/application","id":"23f54d97-ddb2-47e9-b2ab-7f7ca02f6f37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"applicant\": {\n \"firstName\": \"tester\",\n \"lastName\": \"testerson\",\n \"ssn\": \"123456789\",\n \"dob\": \"1979-11-19\",\n \"phone\": \"9713407422\",\n \"email\": \"tester@testerson.com\",\n \"addressLineOne\": \"123 test St\",\n \"addressLineTwo\": \"Apt X\",\n \"city\": \"Jones\",\n \"state\": \"CO\",\n \"zip\": \"98748\",\n \"annualPreTaxIncome\": 500000.00,\n \"disclosuresAcceptedAt\": \"2024-01-30T02:36:32.329Z\",\n \"employerName\": \"job\",\n \"employmentPosition\": \"worker\",\n \"employmentStartDate\": \"1979-07\",\n \"idVerified\": true\n },\n \"institutionName\": \"usalliance\",\n \"requestedAmount\": 6500.00\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/publisher/application","description":"

Initiates an MKIII loan application with the minimum required customer data.

Request

✅ = Required

Field	Sub-field	Type	Description
`requestedAmount`✅		`float` (Up to 2 decimal places)	The amount of money the applicant is requesting to borrow in dollars and cents.
`institutionName`		`string`	The lender who would be financing the loan.
`externalId`		`string`	The client specified external ID of the loan application. Can be anything intended to identify the request from the client consumer side
`loanPurpose`		`number`	Optional: if passing loan purpose, must pass the numerical ID value from the enum below `debt_consolidation = 1, payoff_credit_cards = 2, large_purchase = 3, medical_debt = 4, home_improvement = 5, vacation_expenses = 6, moving_expenses = 7, family_or_life_event = 8, taxes = 9, other = 10`
`applicant`✅		`object`	PII of the customer applying for the loan.
	`firstName`✅	`string`	Applicant first name
	`lastName`✅	`string`	Applicant last name
	`ssn`✅	`string`	Applicant ssn, which is encrypted and stored separately away from other customer PII for extra security.
	`dob`✅	`string` (Date format YYYY-MM-DD i.e. 1985-07-03)	Applicant date of birth
	`phone`✅	`string`	Applicant 10-digit phone number. Must be a US number.
	`email`✅	`string`	Applicant email
	`addressLineOne`✅	`string`	Applicant address line one
	`addressLineTwo`	`string`	Applicant optional address line two
	`city`✅	`string`	Applicant city
	`state`✅	`string`	Applicant state
	`zip`✅	`string`	Applicant zip code
	`annualPreTaxIncome`✅	`float` (Up to 2 decimal places if there are cents)	Applicant annual income before taxes in dollars and cents.
	`disclosuresAcceptedAt`✅	`string` (ISO8601 timestamp)	Timestamp of when the user accepted the terms of this application submission.
	`employerName`	`string`	Name of applicant's employer
	`employmentPosition`	`string`	Applicant's employment position or title
	`employmentStartDate`	`string` (Date in format YYYY-MM i.e. 1985-07)	Month and year applicant started their current position
	`housingStatus`	`string` (Must be 'Own', 'Rent', or 'Other')	Applicant housing status
	`monthlyHousingCost`	`integer`	Cost of applicant's living situation
	`mlaFlag`	`boolean`	Applicant MLA eligibility
	`creditDetails`	`JSON`	Optional extra credit details if available
	`idVerified`	`boolean`	Applicant's IDV status if IDV already preformed.
	`idImages`	`string[]`(Must be list of valid Base64 encoded images)	Applicant's ID images if IDV already preformed
	`bureau`	`string`	Credit Bureau source of the applicant's pre-screen

Special Notes:

If institutionName is not present the institution will be chosen for the applicant based on a best match criteria.
\n
While annualPreTaxIncome is required, employerName, employmentPosition, and employmentStartDate are not. However if these three employer fields are not available to be sent with the request the applicant will not be fully evaluated until employment info is collected in the MKIII onboarding.
\n
housingStatus will default to 'Rent' if not available.
\n
monthlyHousingCost will default to 500 if not available.
\n
If the optional field idVerified is passed explicitly as false the applicant will be denied.
\n

Minimal Example Request Body

{\n  \"requestedAmount\": 5500.00,\n  \"institutionName\": \"allstarlender\",\n  \"applicant\": {\n    \"firstName\": \"testing\",\n    \"lastName\": \"tester\",\n    \"ssn\": \"123456789\",\n    \"dob\": \"1979-11-19\",\n    \"phone\": \"1231231234\",\n    \"email\": \"testing@tester.com\",\n    \"addressLineOne\": \"123 test St\",\n    \"addressLineTwo\": \"Apt X\",\n    \"city\": \"Jones\",\n    \"state\": \"CO\",\n    \"zip\": \"98765\",\n    \"annualPreTaxIncome\": 65000.00,\n    \"employerName\": \"job\",\n    \"employmentPosition\": \"worker\",\n    \"employmentStartDate\": \"1979-07\",\n    \"disclosuresAcceptedAt\": \"2024-01-30T02:36:32.329Z\",\n    \"idVerified\": true\n  }\n}\n\n

Response

Field	Sub-field	Type	Description
`id`		`string`	The MKIII internal ID of the loan application.
`requestId`		`string`	Unique identifier to this specific HTTP request
`externalId`		`string`	The client specified external ID of the loan application. Will not be returned unless specified in the initial request
`institutionName`		`string`	The lender of the loan application.
`continuationUrl`		`string`	The URL to the MKIII web-app where the applicant can finish their application.
`approvedLoanOffers`		`array[offer]`	The list of potential offers for this applicant.
	`offer.institutionName`	`string`	The lender of the loan offer.
	`offer.loanAmount`	`float`	The amount of the loan in dollars.
	`offer.termInMonths`	`integer`	The term of the loan in months.
	`offer.interestRateInBasisPoints`	`integer`	The interest rate of the loan in basis points, i.e. 5% = 500 basis points.
	`offer.financeCharge`	`float`	The finance charge to the loan in dollars if applicable.
	`offer.monthlyPayment`	`float`	The estimated monthly payment of the loan in dollars.
	`offer.finalPayment`	`float`	The estimated final payment of the loan in dollars.
	`offer.totalPayments`	`float`	The estimated total cost of the loan + interest + fees in dollars.
	`offer.originationDate`	`string` (Date format YYYY-MM-DD)	The date of origination.
	`offer.firstPaymentDate`	`string` (Date format YYYY-MM-DD)	The date of the first payment.
	`offer.finalPaymentDate`	`string` (Date format YYYY-MM-DD)	The date of the final payment. Date format: YYYY-MM-DD.
	`offer.originationFee`	`float`	The fee to originate the loan in dollars if applicable.
	`offer.aprInBasisPoints`	`integer`	The APR of the loan in basis points, i.e. 5% = 500 basis points.
	`offer.continuationUrl`	`string`	The same as `continuationUrl` above, however following a continuation url on an offer, will preselect that offer as the chosen offer, and skip offer selection during onboarding.

{\n  \"id\": \"LAP_01J3NW50RR3REJJTD643GWPY78\",\n  \"requestId\": \"01J3NW50NKW8BM5EQ7GNZB9BQJ\",\n  \"institutionName\": \"allstarlender\",\n  \"approvedLoanOffers\": [\n    {\n      \"institutionName\": \"allstarlender\",\n      \"loanAmount\": 6500,\n      \"termInMonths\": 12,\n      \"interestRateInBasisPoints\": 1224,\n      \"financeCharge\": 471.52,\n      \"monthlyPayment\": 580.97,\n      \"finalPayment\": 580.85,\n      \"totalPayments\": 6971.52,\n      \"firstPaymentDate\": \"2024-09-16\",\n      \"originationDate\": \"2024-08-02\",\n      \"finalPaymentDate\": \"2025-08-16\",\n      \"originationFee\": 0,\n      \"aprInBasisPoints\": 1222.8,\n      \"continuationUrl\": \"https://lender.embed.mkiii.dev/application/continue?ct=96f1a294-c776-4585-971b-6fd3d4c303e9&cs=offer&term=12\"\n    }\n  ],\n  \"continuationUrl\": \"https://lender.embed.mkiii.dev/application/continue?ct=96f1a294-c776-4585-971b-6fd3d4c303e9&cs=offer\"\n}\n\n

\n","urlObject":{"path":["v1","publisher","application"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"23f54d97-ddb2-47e9-b2ab-7f7ca02f6f37"}],"id":"a5676e3a-f868-4e21-aaf3-7c5c9ce2109d","_postman_id":"a5676e3a-f868-4e21-aaf3-7c5c9ce2109d","description":""},{"name":"V2 (Coming Soon)","item":[{"name":"/application","id":"94a7ad49-6cd6-45fa-825d-2f4eafa9c66d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"requestedAmount\": 5500.00,\n \"disclosuresAcceptedAt\": \"2024-01-30T02:36:32.329Z\",\n \"institutionName\": \"allstarlender\",\n \"externalId\": \"123456\",\n \"applicant\": {\n \"firstName\": \"testing\",\n \"lastName\": \"tester\",\n \"ssn\": \"123456789\",\n \"dob\": \"1979-11-19\",\n \"phone\": \"1231231234\",\n \"email\": \"testing@tester.com\",\n \"annualPreTaxIncome\": 65000.00,\n \"idVerified\": true,\n \"idImages\": [\n \"'data:image/png;base64,ANSUhEUgAA\",\n \"'data:image/png;base64,E0DHxgljNB\"\n ]\n },\n \"address\": {\n \"addressLineOne\": \"123 test St\",\n \"addressLineTwo\": \"Apt X\",\n \"city\": \"Jones\",\n \"state\": \"CO\",\n \"zip\": \"98765\",\n \"housingStatus\": \"Rent\",\n \"monthlyHousingCost\": 1500,\n \"moveInDate\": \"2002-12\"\n },\n \"employer\": {\n \"employerName\": \"job\",\n \"employmentStatus\": \"Employed\",\n \"employmentPosition\": \"worker\",\n \"employmentStartDate\": \"1979-07\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/application","description":"

Initiates an MKIII loan application with the minimum required customer data.

Request

✅ = Required

Field	Sub-field	Type	Description
`requestedAmount`✅		`float` (Up to 2 decimal places)	The amount of money the applicant is requesting to borrow in dollars and cents.
`institutionName`		`string`	The lender who would be financing the loan.
`externalId`		`string`	The client specified external ID of the loan application. Can be anything intended to identify the request from the client consumer side
`disclosuresAcceptedAt`✅		`string` (ISO8601 timestamp)	Timestamp of when the user accepted the terms of this application submission.
`applicant`✅		`object`	PII of the customer applying for the loan.
	`firstName`✅	`string`	Applicant first name
	`lastName`✅	`string`	Applicant last name
	`ssn`✅	`string`	Applicant ssn, which is encrypted and stored separately away from other customer PII for extra security.
	`annualPreTaxIncome`✅	`float` (Up to 2 decimal places if there are cents)	Applicant annual income before taxes in dollars and cents.
	`dob`	`string` (Date format YYYY-MM-DD i.e. 1985-07-03)	Applicant date of birth
	`phone`	`string`	Applicant 10-digit phone number. Must be a US number.
	`email`	`string`	Applicant email
	`idVerified`	`boolean`	Applicant's IDV status if IDV already preformed.
	`idImages`	`string[]`(Must be list of valid Base64 encoded images)	Applicant's ID images if IDV already preformed
`address`✅		`object`	Address information of the customer applying for the loan.
	`addressLineOne`✅	`string`	Applicant address line one
	`addressLineTwo`	`string`	Applicant optional address line two
	`city`✅	`string`	Applicant city
	`state`✅	`string`	Applicant state
	`zip`✅	`string`	Applicant zip code
	`housingStatus`	`string` (Must be 'Own', 'Rent', or 'Other')	Applicant housing status
	`monthlyHousingCost`	`integer`	Cost of applicant's living situation in dollars, no cents
	`moveInDate`	`string` (Date format YYYY-MM i.e. 2002-07)	Year and month applicant moved into their home
`employer`		`object`	Employment information of the customer applying for the loan.
	`employerName`	`string`	Applicant address line one
	`employmentStatus`	`string` (Must be 'Employed', 'SelfEmployed', or 'Unemployed')	Applicant employment status
	`employmentPosition`	`string`	Applicant optional address line two
	`employmentStartDate`	`string`	Applicant city

Special Notes:

If institutionName is not present the institution will be chosen for the applicant based on a best match criteria.
\n
Optional fields will be saved if passed, or collected when the customer completes onboarding if not.
\n

Example Request Body

{\n  \"requestedAmount\": 5500.00,\n  \"disclosuresAcceptedAt\": \"2024-01-30T02:36:32.329Z\",\n  \"institutionName\": \"allstarlender\",\n  \"externalId\": \"123456\",\n  \"applicant\": {\n    \"firstName\": \"testing\",\n    \"lastName\": \"tester\",\n    \"ssn\": \"123456789\",\n    \"dob\": \"1979-11-19\",\n    \"phone\": \"1231231234\",\n    \"email\": \"testing@tester.com\",\n    \"annualPreTaxIncome\": 65000.00,\n    \"idVerified\": true,\n    \"idImages\": [\n        \"'data:image/png;base64,ANSUhEUgAA\",\n        \"'data:image/png;base64,E0DHxgljNB\"\n    ]\n  },\n  \"address\": {\n    \"addressLineOne\": \"123 test St\",\n    \"addressLineTwo\": \"Apt X\",\n    \"city\": \"Jones\",\n    \"state\": \"CO\",\n    \"zip\": \"98765\",\n    \"housingStatus\": \"Rent\",\n    \"monthlyHousingCost\": 1500,\n    \"moveInDate\": \"2002-12\"\n  },\n  \"employer\": {\n    \"employerName\": \"job\",\n    \"employmentStatus\": \"Employed\",\n    \"employmentPosition\": \"worker\",\n    \"employmentStartDate\": \"1979-07\"\n  }\n}\n\n

Response

Field	Sub-field	Type	Description
`id`		`string`	The MKIII internal ID of the loan application.
`requestId`		`string`	Unique identifier to this specific HTTP request
`externalId`		`string`	The client specified external ID of the loan application. Will not be returned unless specified in the initial request
`continuationUrl`		`string`	The URL to the MKIII web-app where the applicant can finish their application.
`offers`		`array[offer]`	The list of potential offers for this applicant.
	`offer.institutionName`	`string`	The lender of the loan offer.
	`offer.loanAmount`	`float`	The amount of the loan in dollars.
	`offer.termInMonths`	`integer`	The term of the loan in months.
	`offer.interestRateInBasisPoints`	`integer`	The interest rate of the loan in basis points, i.e. 5% = 500 basis points.
	`offer.financeCharge`	`float`	The finance charge to the loan in dollars if applicable.
	`offer.monthlyPayment`	`float`	The estimated monthly payment of the loan in dollars.
	`offer.finalPayment`	`float`	The estimated final payment of the loan in dollars.
	`offer.totalPayments`	`float`	The estimated total cost of the loan + interest + fees in dollars.
	`offer.originationDate`	`string` (Date format YYYY-MM-DD)	The date of origination.
	`offer.firstPaymentDate`	`string` (Date format YYYY-MM-DD)	The date of the first payment.
	`offer.finalPaymentDate`	`string` (Date format YYYY-MM-DD)	The date of the final payment. Date format: YYYY-MM-DD.
	`offer.originationFee`	`float`	The fee to originate the loan in dollars if applicable.
	`offer.aprInBasisPoints`	`integer`	The APR of the loan in basis points, i.e. 5% = 500 basis points.
	`offer.continuationUrl`	`string`	The same as `continuationUrl` above, however following a continuation url on an offer, will preselect that offer as the chosen offer, and skip offer selection during onboarding.

Example Response Body

{\n  \"id\": \"LAP_01J3NW50RR3REJJTD643GWPY78\",\n  \"requestId\": \"01J3NW50NKW8BM5EQ7GNZB9BQJ\",\n  \"offers\": [\n    {\n      \"institutionName\": \"coolcreditunion\",\n      \"loanAmount\": 6500,\n      \"termInMonths\": 12,\n      \"interestRateInBasisPoints\": 1224,\n      \"financeCharge\": 471.52,\n      \"monthlyPayment\": 580.97,\n      \"finalPayment\": 580.85,\n      \"totalPayments\": 6971.52,\n      \"firstPaymentDate\": \"2024-09-16\",\n      \"originationDate\": \"2024-08-02\",\n      \"finalPaymentDate\": \"2025-08-16\",\n      \"originationFee\": 0,\n      \"aprInBasisPoints\": 1222.8,\n      \"continuationUrl\": \"https://lender.embed.mkiii.dev/application/continue?ct=96f1a294-c776-4585-971b-6fd3d4c303e9&cs=offer&term=12\"\n    }\n  ],\n  \"continuationUrl\": \"https://lender.embed.mkiii.dev/application/continue?ct=96f1a294-c776-4585-971b-6fd3d4c303e9&cs=offer\"\n}\n\n

\n","urlObject":{"path":["application"],"query":[],"variable":[]}},"response":[],"_postman_id":"94a7ad49-6cd6-45fa-825d-2f4eafa9c66d"}],"id":"cec0dea7-bcd2-4a08-8226-0d6542419135","_postman_id":"cec0dea7-bcd2-4a08-8226-0d6542419135","description":""}],"id":"e3afaf32-9e80-4cf1-aac6-161d51376200","description":"

The Mark III Rest API provides a near seamless way for lenders and loan offer publishers to get pre-screened applicants onboarded to the Mark III platform for loan insurance.

Authorization

For authorization of requests MKIII uses a Bearer Token passed through the Authorization header. These tokens are generated in our staging environment first, and production credentials will be generated after successfully testing against our staging environment. Please take care to protect the security of these tokens, and reach out to engineering@mkiii.ai immediately if you believe them to be compromised.

\n","_postman_id":"e3afaf32-9e80-4cf1-aac6-161d51376200"},{"name":"MKIII Embed SDK","item":[],"id":"2e97aac5-daef-4d75-a8cc-9fdfa0b19696","description":"

The MarkIII embed (M3E) is an easy, no-config, low-code embedded loan product. With a simple copy paste anyone on the team with access to your app or site can embed it such as your marketing, product, design, or software teams.

Quickstart

Step 1: Get it 📧

You will be given the embed code to copy paste without any configuration from our team. The code however is the same for everyone with the exception to the clientId field which you will get prefilled for you to copy and paste.

Step 2: Paste it 📋

The code given will inject the iframe where you paste this and try to fit into the frame 100% x 100% and blend into the page (no borders, background, etc).

The code will look like this:

<script src=\"https://cdn.mkiii.ai/v1/embed.js\"></script>\n<script>\n  const embed = new MkiiiEmbed({\n    clientId: 'your-client-id',\n  })\n  embed.init()\n</script>\n\n

For most use cases, this is all you will need! For more control, we have options to help with styling and placement.

Step 3: Launch it 🚀

That’s really it! Give it a whirl and launch it. Since its cloud based this is the last time you’ll need to make updates with new updates pushed with no changes needed on your side.

Options

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	Required
`clientId`	The ID for your loan flow. This is unique to you.	✅
`containerSelector`	A CSS selector to inject the iframe into. If not provided the iframe will be injected where the script tag was placed in the DOM.
`styles`	CSS, in JS format, to apply to your iframe element.

`clientId`

The clientId is a string that is specific to you. If you’d like to trial the embedding process before the contracts have been signed or integration is complete, reach out for a demo clientId.

Your client ID will be the same for your development and production environment.

Example

<script src=\"https://cdn.mkiii.ai/v1/embed.js\"></script>\n<script>\n  const embed = new MkiiiEmbed({\n    clientId: 'your-client-id',\n  })\n  embed.init()\n</script>\n\n

`containerSelector`

The containerSelector is any CSS selector to be used to inject the iframe into.

If you do not provide this option it will just place the iframe where you pasted the script tag.

Examples

Paste into place

<html>\n  <head>\n    <comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> ...       -->\n  </head>\n  <body>\n    <h1 class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Apply for a loan</h1>\n    <p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Fill out the form below!</p>\n    <script src=\"https://cdn.mkiii.ai/v1/embed.js\"></script>\n    <script>\n      const embed = new MkiiiEmbed({\n        clientId: 'your-client-id',\n      })\n      embed.init()\n    </script>\n    <footer>\n      All rights reserved to Demo Bank\n    </footer>\n  </body>\n</html>\n\n

Add to head and inject into container

<html>\n  <head>\n    <comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> ...      -->\n    <script src=\"https://cdn.mkiii.ai/v1/embed.js\"></script>\n    <script>\n      const embed = new MkiiiEmbed({\n        clientId: 'your-client-id',\n        // Selector could also be `div` or any CSS selector\n        containerSelector: '#my-iframe-container'\n      })\n      embed.init()\n    </script>\n  </head>\n  <body>\n    <h1 class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Apply for a loan</h1>\n    <p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Fill out the form below!</p>\n    <div class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; id=\"my-iframe-container\"></div>\n    <footer>\n      All rights reserved to Demo Bank\n    </footer>\n  </body>\n</html>\n\n

`styles`

If you want to add some more specific styling to your iframe element (such as more specific sizing) you can use the styles option which takes JS style CSS (i.e. marginTop not margin-top).

By default, this is set to {border: 'none', height: '100%'}. The height is set as well but that happens dynamically.

How is height dynamically set?

If the height of the parent element is 0 it will fallback to 850px otherwise the height will be 100% of the containing element. It does not do height: 100% but rather uses the parent’s offsetHeight and sets the height to a pixel value as 100% height in CSS doesn’t work reliably across all environments.

Examples

Height set automatically

<html>\n  <head>\n    <comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> ...      -->\n    <style>\n      #my-iframe-container {\n        height: 400px;\n      }\n    </style>\n    <script src=\"https://cdn.mkiii.ai/v1/embed.js\"></script>\n    <script>\n      const embed = new MkiiiEmbed({\n        clientId: 'your-client-id',\n        // Selector could also be `div` or any CSS selector\n        containerSelector: '#my-iframe-container'\n      })\n      embed.init()\n    </script>\n  </head>\n  <body>\n    <h1 class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Apply for a loan</h1>\n    <p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Fill out the form below!</p>\n    <div class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; id=\"my-iframe-container\"></div>\n    <footer>\n      All rights reserved to Demo Bank\n    </footer>\n  </body>\n</html>\n\n

Height set manually, border overridden, and adds spacing

<html>\n  <head>\n    <comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> ...      -->\n  </head>\n  <body>\n    <h1 class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Apply for a loan</h1>\n    <p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Fill out the form below!</p>\n    <script src=\"https://cdn.mkiii.ai/v1/embed.js\"></script>\n    <script>\n      const embed = new MkiiiEmbed({\n        clientId: 'your-client-id',\n        // Selector could also be `div` or any CSS selector\n        styles: {\n          border: '1px solid red',\n          height: '1000px',\n          marginTop: '100px'\n        }\n      })\n      embed.init()\n    </script>\n    <footer>\n      All rights reserved to Demo Bank\n    </footer>\n  </body>\n</html>\n\n

Questions?

Any questions or comments feel free to reach out.

For technical questions email: engineering@mkiii.ai
\n
For sales email: sales@mkiii.ai
\n
For a demo: find a time
\n

\n","_postman_id":"2e97aac5-daef-4d75-a8cc-9fdfa0b19696"}]}