Skip to main content

Lend Application Form (Exchange)

Description​

NOTE: This is a specialized endpoint. It's more likely that you want to send the prospect form to Bold Penguin directly.

Create an application form within your Bold Penguin tenant, then lend it to the Bold Penguin Exchange. The prospect remains accessible via the Enterprise Terminal outside of the times when Bold Penguin is actively working with the prospect.

You will need to map the prospect's responses to the Bold Penguin master question set and supply them in the request body for this endpoint.

The endpoint returns an application form ID.

Endpoint​

Staging​

https://partner-engine-uat.beta.boldpenguin.com/tenants/<tenant_id>/lent_application_forms

Production​

https://partner-engine.boldpenguin.com/tenants/<tenant_id>/lent_application_forms

NOTE: that the tenant_id will be different between environments.

Authentication​

This endpoint requires an access_token from the authentication endpoint in the same environment. Include it as a bearer token in an Authorization header for the request.

Authorization: Bearer <access_token>

Methods​

POST

Request Syntax​

POST /tenants/<tenant_id>/lent_application_forms

Request Payload​

The body of the request contains a completed application_form in JSON format. This form must include one or more question codes and answers from the Master Question Set.

{
  "application_form": {
    "answer_values": [
      {
        "code": "mqs_first_name",
        "answer": "<string>"
      },
      {
        "code": "mqs_last_name",
        "answer": "<string>"
      },
      {
        "code": "mqs_business_name",
        "answer": "<string>"
      },
      {
        "code": "mqs_phone",
        "answer": "<string>"
      },
      ...
    ]
  }
}

Request Parameters​

URL Parameters​

  • tenant_id
    • You will be assigned a unique tenant_id for each of our environments.
    • Type: String
    • Required: Yes

JSON Parameters​

Your JSON payload may contain an application_form object with the following properties:

  • answer_values
    • One or more questions and answers to prepopulate in the form
    • Type: JSON object (An array of code and answer tuples)
    • Required: No

NOTE: Applications you intend to send to the Bold Penguin Exchange must inclued the mqs_phone question code with a unique phone number as the answer.

Response Syntax​

{
  "id": "<UUID>",
  "reference_id": "<string>",
  "redirect_url": null
}

Response Elements​

  • id
    • A globally unique ID for this instance of the application form within the tenant. It may change as the form is updated
    • Type: UUID
  • reference_id
    • This ID will remain constant throughout the life of the application form
    • Type: String (Format: XXX-XXX-XXX)
  • redirect_url
    • Not used in this context.
    • Type: null value

Status Codes​

  • 201 Success
  • 401 Unauthorized: The necessary authentication credentials are not present in the request or are incorrect.
  • 422 Parameter validation failure (verify the request body)

Examples​

Example Request​

curl --request POST \
  --url https://partner-engine-uat.beta.boldpenguin.com/tenants/<tenant_id>/lent_application_forms \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "application_form": {
    "answer_values": [
      {
        "code": "mqs_first_name",
        "answer": "John"
      },
      {
        "code": "mqs_last_name",
        "answer": "Smith"
      },
      {
        "code": "mqs_business_name",
        "answer": "XYZ Company"
      },
      {
        "code": "mqs_phone",
        "answer": "6145558888"
      }
    ]
  }
}'

Example Response​

{
  "id": "f4d6130e-bd39-4789-a625-5612835ebf51",
  "reference_id": "8JL-NC2-GD3",
  "redirect_url": null
}