Create Application Form (inbound)

Description

To create a new application form a service request is made to Partner Engine with the following payload. It will return a redirect_url that the consumer can then use to load and start the application form process.

Endpoint

Staging

Production

Authentication

Methods

POST

Request Syntax

POST /tenants/{tenant-id}/application_forms

Request Payload

{
  "application_form": {
    "create_guest_user": true
  }
}

Optional: answers can be passed in the payload to pre-populate know questions in the application form. This is useful if the consumer has already selected a product or provided any contact information prior to transferring to Bold Penguin's application process.

Question Codes

  • {tenant-code}_coverage_types
  • {tenant-code}_business_name
  • {tenant-code}_first_name
  • {tenant-code}_last_name
  • {tenant-code}_email
  • {tenant-code}_phone
  • {tenant-code}_address_1
  • {tenant-code}_address_2
  • {tenant-code}_city
  • {tenant-code}_state
  • {tenant-code}_zipcode
{
  "application_form": {
    "create_guest_user": true,
    "answer_values": [
      {
        "code": "{tenant-code}_zipcode",
        "answer": "43215"
      },
      {
        "code": "{tenant-code}_coverage_types",
        "answer": "Business Owners Policy"
      }
    ]
  }
}

URL Parameters

JSON Parameters

Response Payload

{
  "id": "<application-form-id>",
  "redirect_url": "https://{subdomain}-portal.boldpenguin.com/auth/callback?token=<application-form-auth-token>&token_id=<application-form-token-id>"
}

Response Elements

Status Codes

Examples

Sample Curl command

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"
      }
    ]
  }
}'

Note:

results matching ""

    No results matching ""