Skip to main content

Pre-filling end-user information

2-3 days

If you already hold information about an end customer, you can return that data from your backend so Unit can pre-fill the hosted banking application and reduce the steps the customer has to complete.

Expose a GET endpoint over HTTPS that Unit can call. When an end user starts the Ready-to-Launch Banking application flow, Unit requests your URL once (per user, identified by the JWT sub) with Authorization: Bearer <JWT>.

  • Response: Return HTTP 200 with a JSON:API document — data.type must be whiteLabelAppEndUserConfig, and data.attributes must follow that type (including optional applicantDetails where applicable).
  • Security: Validate the JWT on every request (issuer, audience, signature, expiry) using the same auth setup as your integration. See Custom JWT Authentication.
  • Privacy: Treat any returned applicant data as personally identifiable information: send it only over HTTPS (encrypted), avoid logging sensitive fields, and handle it per your policies.

Configure in the Dashboard

In your Unit Dashboard (sandbox or production, matching your environment): Settings → Ready to Launch → Callbacks.
Set Application Prefill Endpoint to your HTTPS URL.

Note

After saving your URL, contact Unit to complete the setup — Unit must register and allowlist your URL for calls to work.

Callbacks settings

Use Application Prefill Endpoint for the URL Unit should call when the user starts the banking application. Other fields on this page serve different flows.

Unit Dashboard Settings — Callbacks tab, Application Prefill Endpoint

Application form (pre-filled)

When a new customer starts the banking application, fields can appear already filled in from the data your endpoint returned in applicantDetails—for example legal business name, the name the business trades under, and website—so they complete less manual entry.

Create Your Account — banking application form with pre-filled business details

Request

Unit sends this request to your server when an eligible end user begins the banking application. The response you return is what Unit uses to pre-fill the hosted application (see Response below).

ItemDetail
MethodGET
URLYour Application Prefill Endpoint as configured in the Dashboard
HeadersAuthorization: Bearer and the end user's JWT (sub identifies the user)
ConnectionHTTPS only (encrypted traffic); endpoint must be reachable from Unit
curl -X GET 'https://yourdomain.com/unit/prefill' \
-H "Authorization: Bearer ${JWT_TOKEN}"

Implement the handler so repeated calls for the same user return the same payload.

Response

The response body is a JSON:API document. Use the White-label App end user config reference for the full attribute list, supported application types, and a complete example.

{
"data": {
"type": "whiteLabelAppEndUserConfig",
"attributes": {
"allowedApplicationTypes": ["Individual", "SoleProprietorship"],
"requestedProducts": ["Banking"],
"applicantDetails": {
"applicationType": "Individual",
"email": "user@example.com"
}
}
}
}

allowedApplicationTypes accepts any combination of Individual, SoleProprietorship, SingleMemberBusiness, and MultipleMemberBusiness. See the API reference for the full list of prefill fields available per application type.

Test in sandbox

  1. Deploy your GET handler and have Unit configure the sandbox URL, then set Application Prefill Endpoint in the sandbox Dashboard.
  2. Call your endpoint with curl (using a sandbox JWT) and confirm you receive HTTP 200 with a valid whiteLabelAppEndUserConfig document.
  3. Run through the banking application in the app and confirm the expected fields appear pre-filled.