Create Application Form

Description

Create a consumer application form within your Bold Penguin Terminal. You can optionally supply question codes and answers to prepopulate the form.

The endpoint returns an application form ID. Can also return a redirect_url to continue the application in your consumer portal.

Endpoint

Staging

https://partner-engine-uat.beta.boldpenguin.com/tenants/[tenant_id]/application_forms

Production

https://partner-engine.boldpenguin.com/tenants/[tenant_id]/application_forms

Authentication

This endpoint requires an access_token from the authentication endpoint. The token must come from the the same environment, and presented as a bearer token in an Authorization header for the request.

Methods

POST

Request Syntax

POST /tenants/[tenant_id]/application_forms

Request Payload

{
  "application_form": {
    "create_guest_user": true,
    "answer_values": [
      {
        "code": "<string>",
        "answer": "<string>"
      },
      {
        "code": "<string>",
        "answer": "<string>"
      },
      {
        "code": "<string>",
        "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 must include an application_form object with the following properties:

  • create_guest_user
    • Set this to true to generate a redirect URL for consumers. This requires a configured consumer portal for your terminal
    • Type: Boolean
    • Required: No
  • 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:: answer_values is an optional property used to prepopulate questions in the application form. This is useful if the consumer has already selected a product or provided contact information. You may use any of the pre-defined question codes for your tenant.

Response Payload

{
  "id": "<UUID>",
  "redirect_url": "https://[url]?token=[guest-user-auth-token]&token_id=[application-form-token-id]"
}

Response Elements

  • id
    • The unique ID for this application form within the tenant
    • Type: String
  • redirect_url
    • A single use URL for displaying the form for the consumer. Only populated if create_guest_user was true in the request and a consumer portal exists
    • Type: URL String
    • Default: null

Status Codes

  • 201 Success
  • 401 Unauthorized (verify bearer token from authentication)
  • 422 Parameter validation failure (verify the request body against the question codes for your tenant)
  • 500 Internal server error

Examples

Example Request

curl --request POST \
  --url https://partner-engine.boldpenguin.com/tenants/[tenant_id]/application_forms \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "application_form": {
    "create_guest_user": true,
    "answer_values": [
      {
        "code": "[tenant-code]_zipcode",
        "answer": "43215"
      },
      {
        "code": "[tenant-code]_coverage_types",
        "answer": "Business Owners Policy"
      }
    ]
  }
}'

Example Response

{
  "id": "1234a690-2be4-4e95-8516-31cda41f311a",
  "redirect_url": "https://[domain]-portal.boldpenguin.com/auth/callback?token=[application-form-auth-token]&token_id=[application-form-token-id]"
}

results matching ""

    No results matching ""