Skip to content
/
Consumer_Soft_Pull_Reques...

Consumer_Soft_Pull_Request

Request

Overview

This API allows external vendors to initiate a soft credit pull for consumers by providing the required data elements. The API response will return either:

  • Offers with loan product(s) details, or
  • No Offers, which may trigger an Adverse Action Notice (AAN) email to the consumer.

Requirements

  • Authentication (username and password) is required.
  • Sponsor ID is determined by the authentication credentials.
  • Callback URLs must use Basic Auth authentication. Clients must implement Basic Auth for callback URLs and provide credentials to Momnt.
  • API requests will only be processed if the merchant's status is Active.
Security
basicAuth
Body
required
request_user_idstring, <= 255 charactersrequired

ID of the user in the partner system making the application soft pull request.

external_application_idstring, <= 255 charactersrequired

The identifier in the partner system for this loan application.

external_org_idstring, <= 255 characters
consumer_emailstring, (email)required

Consumer's email address. Max length 255.

consumer_phonestringrequired

Consumer's phone number. Format as: +15552223333

consumer_first_namestring, <= 128 charactersrequired

Consumer's First Name.

consumer_middle_namestring, <= 128 characters

Consumer's Middle Name.

consumer_last_namestring, <= 128 charactersrequired

Consumer's Last Name.

consumer_address_1string, <= 255 charactersrequired

Consumer's Street Address.

consumer_address_2string, <= 255 characters

Consumer's Street Address line 2 (if applicable).

consumer_citystring, <= 255 charactersrequired

Consumer's City.

consumer_statestring, = 2 charactersrequired

Consumer's State. Use 2 Letter State Code.

consumer_zip_codestring, [ 5 .. 10 ] charactersrequired

Consumer's 5- or 9-digit Zip Code.

consumer_ssnstring, = 9 charactersrequired

Consumer's Social Security Number (ex. 123456789).

consumer_dobstring, (date)required

Consumer's Date of Birth (ex. YYYY-MM-DD).

consumer_requested_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Loan Amount the consumer is requesting.

annual_incomestring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Provide the annual income. If income is captured in separate fields (e.g., individual income and additional income), ensure additional_household_income field is included.

additional_household_incomestring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$

Sent if additional income is captured separately in the consumer application process.

housing_statusstring

Acceptable values: "Rent", "Own", "Other".

  • Rent - Rent
  • Own - Own
  • Other - Other
Enum:"Rent""Own""Other"
monthly_housing_paymentstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$

Monthly housing payment amount.

mobile_homeboolean

Indicates if the consumer lives in a mobile home.

years_at_current_residenceinteger

Number of years at the current residence.

installation_same_as_homeboolean

Indicates if the installation address is the same as home address.

offer_codestring

Provide offer code that should be applied to the consumer's application.

presented_onstring, (date-time)

Provide date and time the consumer was presented with disclosures if you can collect. Use ISO 8601 format (ex. YYYY-MM-DDThh:mm:ssZ).

consented_onstring, (date-time)required

Provide date and time when the consumer submitted the application. Use ISO 8601 format (ex. YYYY-MM-DDThh:mm:ssZ).

sponsor_callback_urlstring, (uri)

When a consumer loan status is updated, Momnt will POST information to this fully qualified URL.

curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_consumer_v1/api/v1/sponsor/consumers/soft-pull/ \
  -H 'Content-Type: application/json' \
  -d '{
    "request_user_id": "string",
    "external_application_id": "string",
    "external_org_id": "string",
    "consumer_email": "user@example.com",
    "consumer_phone": "string",
    "consumer_first_name": "string",
    "consumer_middle_name": "string",
    "consumer_last_name": "string",
    "consumer_address_1": "string",
    "consumer_address_2": "string",
    "consumer_city": "string",
    "consumer_state": "st",
    "consumer_zip_code": "string",
    "consumer_ssn": "stringstr",
    "consumer_dob": "2019-08-24",
    "consumer_requested_amount": "string",
    "annual_income": "string",
    "additional_household_income": "string",
    "housing_status": "Rent",
    "monthly_housing_payment": "string",
    "mobile_home": true,
    "years_at_current_residence": 0,
    "installation_same_as_home": true,
    "offer_code": "string",
    "presented_on": "2019-08-24T14:15:22Z",
    "consented_on": "2019-08-24T14:15:22Z",
    "sponsor_callback_url": "http://example.com"
  }'

Responses

Bodyapplication/json
consumer_invitation_uuidstring, (uuid)required

Momnt's Consumer Invitation ID.

consumer_application_idstringrequired

Momnt's Human-Friendly Application ID.

soft_pull_credit_limitstringread-onlyrequired

Credit Limit the consumer was approved for.

consumer_requested_amountstring, (decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Requested Amount sent in request.

decisionstringrequired

Values: Offers, No Offers

decision_detailstring

Values: blank, Approved for Less, Frozen Credit

Default:""
offersArray of objects(SoftPullOffer)required
Response
{
  "consumer_invitation_uuid": "bf39a003-16d1-4c95-a53b-e7e6cfe93f0b",
  "consumer_application_id": "string",
  "soft_pull_credit_limit": "string",
  "consumer_requested_amount": "string",
  "decision": "string",
  "decision_detail": "",
  "offers": [
    { … }
  ]
}