Skip to content
/
Consumer Application Invi...

Consumer Application Invitation

Request

For a merchant/contractor to issue a loan to a consumer.

The partner/sponsor must first send a POST to Momnt to initiate the consumer loan.

  • Sends an invite via SMS or Email
  • Only ONE of those fields is required
  • Providing both will result in an error
Security
basicAuth
Body
required
request_user_idstring, <= 255 charactersrequired

The ID in the partner system making the request.

application_idstring, <= 255 charactersrequired

The identifier in the partner system for this loan application.

customer_emailstring, (email)

You must send email OR phone.

customer_phonestring

You must send email OR phone.

sponsor_callback_urlstring, (uri)required

When consumer loan is approved or cancelled, Momnt will POST information to this fully qualified URL. This URL will be called A SECOND TIME when the loan documents are accepted by the consumer (borrower).

consumer_first_namestring, <= 128 characters

The first name of the consumer.

consumer_middle_namestring, <= 128 characters

The middle name of the consumer.

consumer_last_namestring, <= 128 characters

The last name of the consumer.

consumer_address_1string, <= 255 characters

The first line of the consumer's address.

consumer_address_2string, <= 255 characters

The second line of the consumer's address.

consumer_citystring, <= 255 characters

The city of the consumer's address.

consumer_statestring, <= 2 characters

The state of the consumer's address.

consumer_zip_codestring, <= 10 characters

The zip code of the consumer's address.

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

The requested amount of the consumer.

offer_codestring, <= 255 characters

The offer code of the consumer.

external_org_idstring, <= 255 characters

The external organization ID of the consumer.

curl -i -X POST \
  -u '<username>:<password>' \
  https://momnt-api-docs.redocly.app/_mock/docs/openapi/sponsor_consumer_v1/api/v1/sponsor/consumers/application/ \
  -H 'Content-Type: application/json' \
  -d '{
    "request_user_id": "string",
    "application_id": "string",
    "customer_email": "user@example.com",
    "customer_phone": "string",
    "sponsor_callback_url": "http://example.com",
    "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_requested_amount": "string",
    "offer_code": "string",
    "external_org_id": "string"
  }'

Responses

Bodyapplication/json
artis_consumer_invitation_idstring, (uuid)required
contractor_idstring, <= 255 charactersrequired
request_user_invitation_idstring, <= 255 charactersrequired
offer_codestring, <= 255 characters
consumer_invitation_linkstring, (uri)
consumer_requested_amountinteger
Response
{
  "artis_consumer_invitation_id": "c3d8769a-ce49-4f8d-86fb-9e13006f3d08",
  "contractor_id": "string",
  "request_user_invitation_id": "string",
  "offer_code": "string",
  "consumer_invitation_link": "http://example.com",
  "consumer_requested_amount": 0
}

Callbacks

Consumer Application Callback (POST)After the spon
post