Headless Onboarding Integration Guide

If you would like to build your own UX, then then there are APIs available where you can own the UI for Client Users to submit their credentials.

Key Elements in the UI

The key elements to include in your UX are:

• Presentation of the Portal name (e.g. Walmart Retail Link, Ariba, etc.)
• Username field
• Password field

Optional UI Elements:

• Explanation of why the credentials are needed
• Security of the credential storage

Step 1: Get the Correct Portal ID

Utilize the GET Portal IDs request to get the UUIDs of the available portals to present to the user. During your initial integration, these IDs can be provided to you via the PortalDuct Developer Support team.

Coming Soon: _Logos for each portal will be added to the API soon so that you can show the image of the portal along side the name to the user.

Step 2: Submit the Portal Credentials

Utilize the Create New Connection APIto submit credentials for that specific portal associated with the specific Client User account.

Step 3: Check Status and Collect Data

Utilize the PortalDuct Transactions APIs to get data collected on a daily cadence, as well as subscribe to the Webhook to get updates on portal connection errors.

👍

Note: Portals Available

The portals that will be available for your present to your user will be configured to your account based on the onboarding setup with the PortalDuct team. For portals that you have opted to have live, the UUIDs will be available for your engineering team to utilize in the API submission.