Form Retrieval

Description

Guest Application Form Retrieval

To retrieve an application form that a consumer has already started the following information is required:

  • Quote ID (refrence_id)
  • Zipcode
  • Last name

A service request is then made to Partner-Engine with the following payload. It will return a redirect_url that the consumer can then use to load and resume the application form from where they left off.

Endpoint

Staging

Production

Authentication

Methods

POST

Request Path

POST /tenants/{tenant-id}/application_forms/search

Request Payload

{
  "application_form": {
    "create_guest_token": true,
    "reference_id": "XXX-XXX-XXX",
    "answer_values": [
      {
        "code": "mqs_zipcode",
        "answer": "XXXXX"
      },
      {
        "code": "mqs_last_name",
        "answer": "XXXXXXXXXX"
      }
    ]
  }
}

Note: The question codes in the search payload (mqs_) differ from the {tenante specific question codes ({tenant-code}_) used in application form creation.

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/search \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "application_form": {
    "create_guest_token": true,
    "reference_id": "XXX-XXX-XXX",
    "answer_values": [
      {
        "code": "mqs_zipcode",
        "answer": "XXXXX"
      },
      {
        "code": "mqs_last_name",
        "answer": "XXXXXXXXXX"
      }
    ]
  }
}'

results matching ""

    No results matching ""