v1

latestOpenAPI 3.0.42026-07-2419101123.9 KB

VerificationProfiles

Get Verification Profile by External ID

Gets a specific verification profile by its customer-defined external ID.

get/api/valpha/verification-profiles/external-ids/{externalId}

externalIdstring required

Customer-defined external ID

idstring uuid required

The ID of the verification profile

aliasstring required

An alias of the verification profile shown to developers and administrators.

brandNamestring required

The brand name of the verification profile shown to end-users.

externalIdstring nullable

A customer-defined external ID for this verification profile, unique within your organization.

logoUrlstring required

The URL of the verification profile's logo.

primaryColorstring required

The primary color of the verification profile.

enabledProvidersstring[] required

The providers that are currently enabled for the verification profile.

sessionExpirationstring date-span required

The session expiration for verification sessions created with this profile.

isProductionUsageboolean required

Whether this profile is for production usage. Only applicable for Live environment profiles.