Authenticate Bridge Link Endpoint

New bridge link endpoint for single-use token authentication.

/v3/quoting/authenticate_bridge_link Authenticate bridge link

Released: [2024-11-04]

The authenticate bridge link endpoint allows users to validate a single-use token and returns bridge associated data. Once authenticated, the single-use token (and therefore bridge link) will be unusable.

Only clients being bridged to (i.e. HostedX) are expected to use this endpoint. Clients initiating a bridge need only create a bridge link.

Key Features

• Token Validation: Accepts a JSON payload containing the token in the request body, then verifies its authenticity.
• Attribution Parameters: Accepts a JSON payload containing the attribution parameters in the request body for the bridge link.
• Data Retrieval: Returns bridge-related information associated with the token, including cancelUrl, partnerAgencyId, quoteId, and successUrl.
• No Key Restriction: Available to all users without requiring an API key, facilitating easy validations.

Usage Example

POST /v3/quoting/authenticate_bridge_link
Content-Type: application/json

{
  "atributionParameters": {
    "your_attribution_parameter": "string"
  },
  "token": "token"
}

Sample Response

{
  "cancelUrl": "https://www.joinroot.com",
  "partnerAgencyId": "f443e505-9ea0-4f88-8f97-bd21faa2821e",
  "quoteId": "b9d9e95a-0db9-4835-9cff-05425306ac59",
  "successUrl": "https://www.joinroot.com/customer-app",
}

Notes:

• Token Usability: Each token can only be used once for validation. After a successful validation, the token becomes invalid and cannot be reused.
• Error Handling:
  • If the token is invalid, the endpoint returns a 404 Not Found response with an error message.
  • If the token has already been authenticated once, the endpoint also returns a 404 Not Found.
  • If the token is missing from the request body, the endpoint returns a 400 Bad Request response indicating that the token is required.