Onboarding

The VX API onboarding process is designed to help wallet relying parties (RPs) gain access to the API and integrate it seamlessly into their systems. This guide outlines the steps for customers to onboard and start using the VX API.

Step 1: Request Access to the VX API

1. Submit an Access Request:

   • Contact our support team.
   • Provide the following details:
     • Organization name
     • Contact information
     • Intended use case
     • Required attribute scope

2. Access Approval:

   • Our team will review your request and provide API credentials upon approval.

3. Receive API Credentials:

   • You will receive the following credentials:
     • email and one-time password for the VX management site

4. Application client- id and secret

   • Generate client- id and secret for application using VX management site

Step 2: Configure Your Integration

Setup your application according to the guide received by mail, in-depth documentation is available in our OpenAPI document.

VX API Workflow

Once you have access to the VX API, the typical workflow involves the following steps:

1. Initiate Credential Verification:

   • Send a verification request to the VX API, specifying the required attributes, and redirect to verification-page.

2. Wallet Interaction:

   • The user interacts with their wallet to approve the request and share the requested credentials.

3. Receive and Validate Credentials:

   • The VX API returns the requested attributes, cryptographically signed to prevent tampering.

4. Complete the Operation:

   • Use the attributes to complete the intended operation, such as granting access or processing a transaction.

By following these steps, customers can quickly onboard and leverage the VX API to enable secure and compliant interactions with EUDI wallets.