Lend Application Form (inbound)

Description

Create a new prospect application form within your tenancy, then lend it to the Bold Penguin Exchange. The prospect remains accessible via the Bold Penguin 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.

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

Authentication

This endpoint requires an access_token from the authentication endpoint in the same environment presented as a bearer.

Methods

POST

Request Syntax

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. The tenant_id is your identifier within the Bold Penguin Exchange.
    • Type: String
    • Required: Yes

JSON Parameters

  • application_form

Response Syntax

  {
  "id": <uid string>,
  "redirect_url": null
  }

Response Elements

  • id
    • The unique ID for this application form in your tenancy
    • Type: String
  • redirect_url
    • Not used in this context.
    • Type: Null value

Status Codes

  • 201: Success
  • 401: Unauthorized (verify bearer token from authentication)
  • 422: Parameter validation failure (verify the request body against the master question set)
  • 500: Internal server error

Examples

Example Request

$ cat data.json
{
  "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"
      }
    ]
  }
}
$ curl -v -X POST \
       --header 'Authorization: Bearer <access_token>' \
       --header "Content-Type: application/json" \
       -d @data.json \
       https://partner-engine-uat.beta.boldpenguin.com/tenants/<tenant_id>/lent_application_forms

Example Response

{
  "id": "f4d6130e-bd39-4789-a625-5612835ebf51",
  "redirect_url": null
}

results matching ""

    No results matching ""