Verifications

Endpoints for managing verifications

Trigger an AnonCred verification flow

post

This endpoint allows you to trigger an AnonCred verification flow.

Authorizations

x-api-keystringRequired

Query parameters

timeoutintegerOptional

The timeout for the verification (seconds).

Example: 30

Body

invitation_idinteger · nullableOptional

The ID of the invitation.

contact_idstringOptional

The ID of the contact.

rulestringOptional

The rule for the verification.

Responses

200

AnonCred verification flow triggered successfully

application/json

verification_idintegerOptional

The ID of the verification

Example: 1

connection_idstring · nullableOptional

The connection ID

Example: bd8d1663-38ac-46c8-9314-7d26bf731c88

contact_idstringOptional

The contact ID

invitation_idinteger · nullableOptional

The invitation ID

Example: 1

schema_idstring · nullableOptional

The schema ID

schema_attributesobjectOptional

The schema attributes for verification

wallet_idstringOptional

The wallet ID

Example: 70b6a0d2-628a-4de6-af96-144100f74878

rulestringOptional

The verification rule

Example: no rule

meta_dataobject · nullableOptional

Additional metadata

statestring · nullableOptional

The verification state

Example: done

completebooleanOptional

Whether verification is complete

Example: false

resultbooleanOptional

The verification result

Example: false

result_stringstringOptional

Human readable verification result

Example: Pending

presentation_exchange_idstring[]Optional

Presentation exchange IDs

errorstringOptional

Error message if any

created_atstring · date-timeOptional

Creation timestamp

Example: 2025-07-08T21:54:59.969Z

updated_atstring · date-timeOptional

Update timestamp

Example: 2025-07-08T21:55:01.017Z

400

Bad request.

application/json

401

Unauthorized.

500

Internal server error

application/json

post

/api/v1/verifications

POST /api/v1/verifications HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "invitation_id": 1,
  "contact_id": "",
  "schemas": [
    {
      "schema_attributes": {
        "domain": {
          "restrictions": [
            {
              "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0"
            }
          ]
        }
      }
    }
  ],
  "rule": "no rule"
}

{
  "verification_id": 1,
  "connection_id": "bd8d1663-38ac-46c8-9314-7d26bf731c88",
  "contact_id": "",
  "invitation_id": 1,
  "schema_id": null,
  "schema_attributes": {
    "domain": {
      "restrictions": [
        {
          "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0"
        }
      ]
    }
  },
  "wallet_id": "70b6a0d2-628a-4de6-af96-144100f74878",
  "rule": "no rule",
  "meta_data": null,
  "state": null,
  "complete": false,
  "result": false,
  "result_string": "Pending",
  "result_data": null,
  "presentation_exchange_id": [
    "531298a5-31a6-4f2b-9dec-80c8c9e1d9de"
  ],
  "error": "",
  "created_at": "2025-07-08T21:54:59.969Z",
  "updated_at": "2025-07-08T21:55:01.017Z"
}

Retrieve an AnonCred verification record by ID

get

This endpoint allows you to retrieve an AnonCred verification record by its ID.

Authorizations

x-api-keystringRequired

Path parameters

verification_idstringRequired

The ID of the verification.

Example: 1

Responses

200

AnonCred verification record was retrieved

application/json

verification_idintegerOptional

The ID of the verification

Example: 1

connection_idstring · nullableOptional

The connection ID

Example: bd8d1663-38ac-46c8-9314-7d26bf731c88

contact_idstringOptional

The contact ID

invitation_idinteger · nullableOptional

The invitation ID

Example: 1

schema_idstring · nullableOptional

The schema ID

schema_attributesobjectOptional

The schema attributes for verification

wallet_idstringOptional

The wallet ID

Example: 70b6a0d2-628a-4de6-af96-144100f74878

rulestringOptional

The verification rule

Example: no rule

meta_dataobject · nullableOptional

Additional metadata

statestring · nullableOptional

The verification state

Example: done

completebooleanOptional

Whether verification is complete

Example: false

resultbooleanOptional

The verification result

Example: false

result_stringstringOptional

Human readable verification result

Example: Pending

presentation_exchange_idstring[]Optional

Presentation exchange IDs

errorstringOptional

Error message if any

created_atstring · date-timeOptional

Creation timestamp

Example: 2025-07-08T21:54:59.969Z

updated_atstring · date-timeOptional

Update timestamp

Example: 2025-07-08T21:55:01.017Z

400

Bad request.

application/json

401

Unauthorized.

500

Internal server error

application/json

get

/api/v1/verifications/{verification_id}

GET /api/v1/verifications/{verification_id} HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "verification_id": 1,
  "connection_id": "bd8d1663-38ac-46c8-9314-7d26bf731c88",
  "contact_id": "",
  "invitation_id": 1,
  "schema_id": null,
  "schema_attributes": {
    "domain": {
      "restrictions": [
        {
          "schema_id": "E8BS9Fcg3cu2m9Dwaa3hVG:2:Email:1.0"
        }
      ]
    }
  },
  "wallet_id": "70b6a0d2-628a-4de6-af96-144100f74878",
  "rule": "no rule",
  "meta_data": null,
  "state": null,
  "complete": false,
  "result": false,
  "result_string": "Pending",
  "result_data": null,
  "presentation_exchange_id": [
    "531298a5-31a6-4f2b-9dec-80c8c9e1d9de"
  ],
  "error": "",
  "created_at": "2025-07-08T21:54:59.969Z",
  "updated_at": "2025-07-08T21:55:01.017Z"
}

Retrieve a JSON-LD verification

get

This endpoint retrieves a JSON-LD verification by its ID using the provided API key.

Authorizations

x-api-keystringRequired

Path parameters

verification_idstringRequired

The ID of the verification.

Example: 1

Responses

200

JSON-LD verification record retrieved successfully

application/json

verification_idintegerOptional

The ID of the verification

Example: 1

connection_idstring · nullableOptional

The connection ID

Example: bd8d1663-38ac-46c8-9314-7d26bf731c88

contact_idstringOptional

The contact ID

invitation_idinteger · nullableOptional

The invitation ID

Example: 1

schema_idstring · nullableOptional

The schema ID

schema_attributesobjectOptional

The schema attributes for verification

wallet_idstringOptional

The wallet ID

Example: 70b6a0d2-628a-4de6-af96-144100f74878

rulestringOptional

The verification rule

Example: no rule

meta_dataobject · nullableOptional

Additional metadata

statestring · nullableOptional

The verification state

Example: done

completebooleanOptional

Whether verification is complete

Example: false

resultbooleanOptional

The verification result

Example: false

result_stringstringOptional

Human readable verification result

Example: Pending

presentation_exchange_idstring[]Optional

Presentation exchange IDs

errorstringOptional

Error message if any

created_atstring · date-timeOptional

Creation timestamp

Example: 2025-07-08T21:54:59.969Z

updated_atstring · date-timeOptional

Update timestamp

Example: 2025-07-08T21:55:01.017Z

400

Bad request.

application/json

401

Unauthorized.

404

JSON-LD verification record not found

application/json

500

Internal Server Error

application/json

get

/api/v1/verifications/json-ld/{verification_id}

GET /api/v1/verifications/json-ld/{verification_id} HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Accept: */*

{
  "verification_id": 1,
  "connection_id": "1c50d6e1-5a43-48d8-837e-be3cbc815469",
  "contact_id": "",
  "invitation_id": 1,
  "context": [
    "https://www.w3.org/2018/credentials#VerifiableCredential",
    "https://www.w3.org/2018/credentials/v1",
    "https://purl.imsglobal.org/spec/vc/ob/vocab.html#OpenBadgeCredential"
  ],
  "attributes": [
    "validFrom",
    {
      "issuer": "name"
    },
    {
      "credentialSubject": {
        "achievement": "criteria"
      }
    }
  ],
  "wallet_id": "19fa3524-2859-43e2-ac48-2136c9d8a199",
  "label": "Awesome JSON-LD Credential",
  "rule": "no rule",
  "meta_data": null,
  "state": "done",
  "complete": true,
  "result": true,
  "result_string": "Verified",
  "result_data": [
    {
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
        "https://www.w3.org/ns/credentials/status/v1",
        "https://w3id.org/security/suites/ed25519-2020/v1"
      ],
      "id": "urn:uuid:e67ecd34-2891-45c5-85bd-84d1e34c0653",
      "type": [
        "VerifiableCredential",
        "OpenBadgeCredential"
      ],
      "issuer": {
        "id": "did:indy:indicio:test:JKdq87RF5kEsfv7b8BAdqs",
        "url": "https://www.awesome-issuer-url.com",
        "name": "Awesome Issuer Name",
        "type": [
          "Profile"
        ],
        "email": "[email protected]",
        "image": {
          "id": "https://www.awesome-issuer-url.com/images/issuer-logo.png",
          "type": "Image",
          "caption": "Awesome Issuer Logo"
        },
        "description": "An awesome Issuer who Issues awesome credentials."
      },
      "issuanceDate": "2024-11-29T21:07:11Z",
      "expirationDate": "2030-11-29T11:34:20Z",
      "validFrom": "2024-11-29T11:34:20Z",
      "validUntil": "2030-11-29T11:34:20Z",
      "credentialSubject": {
        "type": [
          "AchievementSubject"
        ],
        "achievement": {
          "id": "https://example.org/achievements/degree",
          "name": "Your name",
          "type": [
            "Achievement"
          ],
          "image": {
            "id": "https://example.org/achievements/image.png",
            "type": "Image"
          },
          "criteria": {
            "type": "Criteria",
            "narrative": "Your narrative"
          },
          "description": "Your description"
        },
        "id": "did:key:z6MkfsAwW9KmjuMGjeKzYnZ9APMoa6StVxpm9TR91XZYHBKJ"
      },
      "credentialStatus": {
        "id": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0#81407",
        "type": "BitstringStatusListEntry",
        "statusPurpose": "revocation",
        "statusListIndex": 81407,
        "statusListCredential": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0"
      },
      "proof": {
        "type": "Ed25519Signature2020",
        "proofPurpose": "assertionMethod",
        "verificationMethod": "did:indy:indicio:test:JKdq87RF5kEsfv7b8BAdqs#assert",
        "created": "2025-07-09T19:28:03.680Z",
        "proofValue": "z2BjheUpL2P77hWdd1Snhw94vJzeuUoze5DTCjeHoAgYB2agA4dF1K4s3wdB2JCRS7yoXhGsk63xVBQw6aGnYV6H8"
      },
      "name": "New Awesome JSON-LD Credential",
      "awardedDate": "2024-11-29T21:07:11Z",
      "description": "Awesome Credential Description"
    }
  ],
  "presentation_exchange_id": [
    "188aba4f-7fc9-4040-93fd-37530fa46027"
  ],
  "error": "",
  "created_at": "2025-07-09T19:30:24.271Z",
  "updated_at": "2025-07-09T19:30:38.964Z"
}

Trigger a JSON-LD verification flow

post

This endpoint allows you to trigger a JSON-LD verification flow.

Authorizations

x-api-keystringRequired

Query parameters

timeoutintegerOptional

The timeout for the verification (seconds).

Example: 30

Body

invitation_idintegerOptional

The ID of the invitation.

Example: 1

contact_idstringOptional

The ID of the contact.

rulestringOptional

The rule for the verification.

Example: no rule

Responses

200

Verification was triggered

application/json

verification_idintegerOptional

The ID of the verification

Example: 1

connection_idstring · nullableOptional

The connection ID

Example: bd8d1663-38ac-46c8-9314-7d26bf731c88

contact_idstringOptional

The contact ID

invitation_idinteger · nullableOptional

The invitation ID

Example: 1

schema_idstring · nullableOptional

The schema ID

schema_attributesobjectOptional

The schema attributes for verification

wallet_idstringOptional

The wallet ID

Example: 70b6a0d2-628a-4de6-af96-144100f74878

rulestringOptional

The verification rule

Example: no rule

meta_dataobject · nullableOptional

Additional metadata

statestring · nullableOptional

The verification state

Example: done

completebooleanOptional

Whether verification is complete

Example: false

resultbooleanOptional

The verification result

Example: false

result_stringstringOptional

Human readable verification result

Example: Pending

presentation_exchange_idstring[]Optional

Presentation exchange IDs

errorstringOptional

Error message if any

created_atstring · date-timeOptional

Creation timestamp

Example: 2025-07-08T21:54:59.969Z

updated_atstring · date-timeOptional

Update timestamp

Example: 2025-07-08T21:55:01.017Z

400

Bad request.

application/json

401

Unauthorized.

500

Internal Server Error

application/json

post

/api/v1/verifications/json-ld

POST /api/v1/verifications/json-ld HTTP/1.1
Host: proven-4-2-test.proven.indicio.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 384

{
  "invitation_id": 1,
  "contact_id": "",
  "definitions": [
    {
      "context": [
        "https://www.w3.org/2018/credentials#VerifiableCredential",
        "https://www.w3.org/2018/credentials/v1",
        "https://purl.imsglobal.org/spec/vc/ob/vocab.html#OpenBadgeCredential"
      ],
      "attributes": [
        "validFrom",
        {
          "issuer": "name"
        },
        {
          "credentialSubject": {
            "achievement": "criteria"
          }
        }
      ],
      "label": "Awesome JSON-LD Credential"
    }
  ],
  "rule": "no rule"
}

{
  "verification_id": 1,
  "connection_id": "1c50d6e1-5a43-48d8-837e-be3cbc815469",
  "contact_id": "",
  "invitation_id": 1,
  "context": [
    "https://www.w3.org/2018/credentials#VerifiableCredential",
    "https://www.w3.org/2018/credentials/v1",
    "https://purl.imsglobal.org/spec/vc/ob/vocab.html#OpenBadgeCredential"
  ],
  "attributes": [
    "validFrom",
    {
      "issuer": "name"
    },
    {
      "credentialSubject": {
        "achievement": "criteria"
      }
    }
  ],
  "wallet_id": "19fa3524-2859-43e2-ac48-2136c9d8a199",
  "label": "Awesome JSON-LD Credential",
  "rule": "no rule",
  "meta_data": null,
  "state": "done",
  "complete": true,
  "result": true,
  "result_string": "Verified",
  "result_data": [
    {
      "@context": [
        "https://www.w3.org/2018/credentials/v1",
        "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json",
        "https://www.w3.org/ns/credentials/status/v1",
        "https://w3id.org/security/suites/ed25519-2020/v1"
      ],
      "id": "urn:uuid:e67ecd34-2891-45c5-85bd-84d1e34c0653",
      "type": [
        "VerifiableCredential",
        "OpenBadgeCredential"
      ],
      "issuer": {
        "id": "did:indy:indicio:test:JKdq87RF5kEsfv7b8BAdqs",
        "url": "https://www.awesome-issuer-url.com",
        "name": "Awesome Issuer Name",
        "type": [
          "Profile"
        ],
        "email": "[email protected]",
        "image": {
          "id": "https://www.awesome-issuer-url.com/images/issuer-logo.png",
          "type": "Image",
          "caption": "Awesome Issuer Logo"
        },
        "description": "An awesome Issuer who Issues awesome credentials."
      },
      "issuanceDate": "2024-11-29T21:07:11Z",
      "expirationDate": "2030-11-29T11:34:20Z",
      "validFrom": "2024-11-29T11:34:20Z",
      "validUntil": "2030-11-29T11:34:20Z",
      "credentialSubject": {
        "type": [
          "AchievementSubject"
        ],
        "achievement": {
          "id": "https://example.org/achievements/degree",
          "name": "Your name",
          "type": [
            "Achievement"
          ],
          "image": {
            "id": "https://example.org/achievements/image.png",
            "type": "Image"
          },
          "criteria": {
            "type": "Criteria",
            "narrative": "Your narrative"
          },
          "description": "Your description"
        },
        "id": "did:key:z6MkfsAwW9KmjuMGjeKzYnZ9APMoa6StVxpm9TR91XZYHBKJ"
      },
      "credentialStatus": {
        "id": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0#81407",
        "type": "BitstringStatusListEntry",
        "statusPurpose": "revocation",
        "statusListIndex": 81407,
        "statusListCredential": "https://example.com/jsonld-status-list/tenants/19fa3524-2859-43e2-ac48-2136c9d8a199/w3c/status/0"
      },
      "proof": {
        "type": "Ed25519Signature2020",
        "proofPurpose": "assertionMethod",
        "verificationMethod": "did:indy:indicio:test:JKdq87RF5kEsfv7b8BAdqs#assert",
        "created": "2025-07-09T19:28:03.680Z",
        "proofValue": "z2BjheUpL2P77hWdd1Snhw94vJzeuUoze5DTCjeHoAgYB2agA4dF1K4s3wdB2JCRS7yoXhGsk63xVBQw6aGnYV6H8"
      },
      "name": "New Awesome JSON-LD Credential",
      "awardedDate": "2024-11-29T21:07:11Z",
      "description": "Awesome Credential Description"
    }
  ],
  "presentation_exchange_id": [
    "188aba4f-7fc9-4040-93fd-37530fa46027"
  ],
  "error": "",
  "created_at": "2025-07-09T19:30:24.271Z",
  "updated_at": "2025-07-09T19:30:38.964Z"
}

PreviousTAA NextSettings

Last updated 21 days ago

Was this helpful?