Skip to main content

Create Credential Order

Integrators can utilize this endpoint to create a credential order, specifying issuance ID, credential type ID, recipient's email, payload, identity verification details, and language preference. This endpoint facilitates the streamlined initiation of credential creation processes within VIDcredentials Studio.

Request Body — REQUIRED
issuanceId string — REQUIRED

ID of credential issuing process. Can be random in order to not coincide with other issuing processes.

credentialTypeId string — REQUIRED

Credential type ID

email string — REQUIRED

The email of the recipient of the credential

payload object — REQUIRED

The content of the credentialSubject. This payload must comply with the same data structure of the credentialType of the credential that is being issued. Note that if there's an id field in the credentialSubject, this id has to be the did of the subject of the credential, following the W3C standard.

language string — REQUIRED

The language in which the user will receive the email to accept and receive the credential

entityDid string

The did of the entity issuing the credential

identityVerificationMethod object — REQUIRED
type string — REQUIRED

Type of user verification method requested. Can be F2F or EmailCredential

userData object

If verification Method type is F2F, the UserData must be filed with legal user data.

userName string — REQUIRED

Full name of the user receiving the credential

userLegalId string — REQUIRED

Legal ID of the user receiving the credential

requestedInfo object[]

If verification Method type is EmailCredential, the RequestedInfo must be filed with the Verifiable Credential expected attributes.

path string — REQUIRED

Location of the attribute in the Credential Subject of the Verifiable Credential to be checked.

value string — REQUIRED

Value of the expected attributes.

Responses
201

Credential Order Created Successfully