<aside> ℹ️

Please see API Authentication for a detailed description of how to authenticate yourself with our API.

</aside>

<aside> ❗

Make sure to use the correct URL depending on the environment you’re working in. Any code examples on this page will only be representative of one environment. Adjust your code as required.

PRODUCTION

api.caro.vc auth.caro.vc caro-prod.us.auth0.com/oauth/token

STAGING

api.caro.vegas auth.caro.vegas caro-vegas.us.auth0.com/oauth/token

</aside>

*POST /api/v1/credentials*

Issue Credential

The Create Credential API creates a verifiable credential in response to an onboarding request launched by a trading partner user. The API can be used by the Credential Issuer to provide CARO with the created credentials.

Issued credentials are revocable by default via Spherity's EthrRevocationRegistry revocation method. If you wish to use the LDAP revocation method, make sure to specify the optional credentialStatusId parameter with all necessary information.

Required attributes

credentialType enum | string

• Type of the credential (IdentityCredential OR DSCSAATPCredential OR DSCSAAuthorityCredential OR DSCSAATPEquivalentCredential).

recipientDid string

• The DID that will receive and hold the credential.

data json

• The json of Credential Data described below.

Optional attributes

credentialId string (urn:uuid:)

• ID of the issued credential. If left out, CARO will generate an appropriate ID.

credentialStatusId string

• CredentialStatus URL in LDAP format. If left out, EthrRevocationRegistry method will be used by default.

expirationDate string (ISO 8601 format)