Issuing ISO mDL with the Blerify API

This section of the documentation explains how to use the Blerify API to issue ISO Mobile Driver's License (mDL).

API Endpoints for License Issuance

The following are the Blerify API endpoints for mDL issuance:

1- "Create" Endpoint

  • Description: This endpoint is used to create a ISO mDL format.

  • HTTP Method: POST

  • Endpoint URL: {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials

End Point to create a Digital Credential

2- "Sign" Endpoint

  • Description: This endpoint is used to sign the ISO mDL created in the previous step.

  • HTTP Method: POST

  • Endpoint URL: {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/crypto/sign/es256

End Point to Sign a Digital Credential

3- "Assemble" Endpoint

  • Description: This endpoint is used to combine the ISO mDL and the signature into a single object, which is delivered to the end user.

  • HTTP Method: PUT

  • Endpoint URL: {{api-host}}/api/v1/organizations/{{organization-id}}/projects/{{project-id}}/credentials/{{_credential_id}}/sign

End Point to assemble a Digital Credential

Example Workflow

  1. The Service Account is created in the Blerify portal and the JSON file is downloaded.

  2. A library (preferred by the client) is used to generate the access token.

  3. The "Create" endpoint is called to create the ISO mDL, sending the access token at all times and generating it again if necessary.

  4. The Digital Credential ID is received in the response.

  5. The "Sign" endpoint is called using the Digital Credential ID.

  6. The digital signature of the ISO mDL is received in the response.

  7. The "Assemble" endpoint is called using the Digital Credential ID and the digital signature.

  8. The complete credential object is received in the response.

  9. This object is delivered to the end user for download to their wallet.

Last updated