Fetch the visual design details

This API endpoint allows you to fetch the details of the visual design configured for a specific user.

Headers

  • Authentication: Bearer <JWT>
  • Accept: application/json
  • Content-Type: application/json

Path Parameters

Parameters

Type

Description

organizationName

string

Denotes the name of the organization.

requestFrom

string

Indicates where the request is from.

  • *Possible Values**:

    web_portal_summary: When the request to fetch the visual design details is when the enrollment summary is viewed or during the approval process which fetches the enrollment summary for review.
    web_portal_enroll_summary: When the request to fetch the visual design details is at the end of the enrollment process on the enrollment summary page.

userId

string

The unique identifier of the user.

Response Parameters

ParameterTypeDescription
idintegerThe unique identifier of the visual template.
workflowMobileIdentityIssuanceIdintegerThe ID of the workflow mobile identity issuance.
visualTemplateIDintegerThe ID of the visual template.
visualTemplateNamestringThe name of the visual template.
frontOrientationstringThe orientation of the front side of the visual design
backOrientationstringThe orientation of the back side of the visual design
identityTypeNamestringThe type of identity associated with the visual design.
Language
URL