Verify credentials
To check a holder's credential, you send them a verification request made from a verification template. In the SDK, a verification request is called a proof request.
In EU Digital Identity, Microsoft Entra and Polygon, the response contains a verificationUrl: show it to the holder as a QR code or link. In cheqd and Indicio, the request is sent over a connection, so you pass a connectionId.
Send proof request
Sends a verification request.
EU Digital Identity
Microsoft Entra
cheqd
Indicio
Polygon
import { OpenIdEcosystem } from '@hovi/core-sdk';
const openid = new OpenIdEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await openid.sendProofRequest({
organizationId: '<ORGANIZATION_ID>',
verificationTemplateId: '<VERIFICATION_TEMPLATE_ID>',
});
import { EntraEcosystem } from '@hovi/core-sdk';
const entra = new EntraEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await entra.sendProofRequest({
organizationId: '<ORGANIZATION_ID>',
verificationTemplateId: '<VERIFICATION_TEMPLATE_ID>',
});
import { CheqdEcosystem } from '@hovi/core-sdk';
const cheqd = new CheqdEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await cheqd.sendProofRequest({
organizationId: '<ORGANIZATION_ID>',
verificationTemplateId: '<VERIFICATION_TEMPLATE_ID>',
connectionId: '<CONNECTION_ID>',
});
import { IndicioEcosystem } from '@hovi/core-sdk';
const indicio = new IndicioEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await indicio.sendProofRequest({
organizationId: '<ORGANIZATION_ID>',
verificationTemplateId: '<VERIFICATION_TEMPLATE_ID>',
connectionId: '<CONNECTION_ID>',
});
import { PrivadoEcosystem } from '@hovi/core-sdk';
const privado = new PrivadoEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await privado.sendProofRequest({
organizationId: '<ORGANIZATION_ID>',
verificationTemplateId: '<VERIFICATION_TEMPLATE_ID>',
});
Params
| Parameter | Type | Description |
|---|---|---|
| organizationId | string (Required) | Your organization ID. |
| verificationTemplateId | string (Required) | The ID of the verification template to use. |
| connectionId | string (Optional) | cheqd and Indicio: the ID of the connection to send the request to. |
| comment | string (Optional) | A message for the holder. |
Get all proof requests
Lists an organization's verification requests.
EU Digital Identity
Microsoft Entra
cheqd
Indicio
Polygon
import { OpenIdEcosystem } from '@hovi/core-sdk';
const openid = new OpenIdEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const requests = await openid.getAllProofRequests({
organizationId: '<ORGANIZATION_ID>',
});
import { EntraEcosystem } from '@hovi/core-sdk';
const entra = new EntraEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const requests = await entra.getAllProofRequests({
organizationId: '<ORGANIZATION_ID>',
});
import { CheqdEcosystem } from '@hovi/core-sdk';
const cheqd = new CheqdEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const requests = await cheqd.getAllProofRequests({
organizationId: '<ORGANIZATION_ID>',
});
import { IndicioEcosystem } from '@hovi/core-sdk';
const indicio = new IndicioEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const requests = await indicio.getAllProofRequests({
organizationId: '<ORGANIZATION_ID>',
});
import { PrivadoEcosystem } from '@hovi/core-sdk';
const privado = new PrivadoEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const requests = await privado.getAllProofRequests({
organizationId: '<ORGANIZATION_ID>',
});
Params
| Parameter | Type | Description |
|---|---|---|
| organizationId | string (Required) | Your organization ID. |
| state | string (Optional) | Return only requests in this state: pending, done or abandoned. Microsoft Entra also uses expired. |
Get proof request by ID
Gets one verification request, for example to see whether the holder has answered. The state done means the credential was valid.
EU Digital Identity
Microsoft Entra
cheqd
Indicio
Polygon
import { OpenIdEcosystem } from '@hovi/core-sdk';
const openid = new OpenIdEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await openid.getProofRequestById({
organizationId: '<ORGANIZATION_ID>',
proofExchangeId: '<PROOF_EXCHANGE_ID>',
});
import { EntraEcosystem } from '@hovi/core-sdk';
const entra = new EntraEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await entra.getProofRequestById({
organizationId: '<ORGANIZATION_ID>',
proofExchangeId: '<PROOF_EXCHANGE_ID>',
});
import { CheqdEcosystem } from '@hovi/core-sdk';
const cheqd = new CheqdEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await cheqd.getProofRequestById({
organizationId: '<ORGANIZATION_ID>',
proofExchangeId: '<PROOF_EXCHANGE_ID>',
});
import { IndicioEcosystem } from '@hovi/core-sdk';
const indicio = new IndicioEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await indicio.getProofRequestById({
organizationId: '<ORGANIZATION_ID>',
proofExchangeId: '<PROOF_EXCHANGE_ID>',
});
import { PrivadoEcosystem } from '@hovi/core-sdk';
const privado = new PrivadoEcosystem({
apiKey: '<YOUR_API_KEY>',
});
const request = await privado.getProofRequestById({
organizationId: '<ORGANIZATION_ID>',
proofExchangeId: '<PROOF_EXCHANGE_ID>',
});
Params
| Parameter | Type | Description |
|---|---|---|
| organizationId | string (Required) | Your organization ID. |
| proofExchangeId | string (Required) | The ID of the verification request, returned when you sent it. |