Verifications

Endpoints for managing verifications

Trigger an AnonCred verification flow

post

This endpoint allows you to trigger an AnonCred verification flow.

Authorizations
Query parameters
timeoutstringOptional

The timeout for the verification.

Example: 15
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
post
POST /api/v1/verifications HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 235

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

Retrieve an AnonCred verification record by ID

get

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

Authorizations
Path parameters
idstringRequired

The ID of the verification.

Example: 1
Responses
200
AnonCred verification record was retrieved
application/json
get
GET /api/v1/verifications/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{}

Retrieve a JSON-LD verification

get

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

Authorizations
Path parameters
idstringRequired

The ID of the verification.

Example: 1
Responses
200
JSON-LD verification record retrieved successfully
application/json
get
GET /api/v1/verifications/json-ld/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{}

Trigger a JSON-LD verification flow

post

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

Authorizations
Query parameters
timeoutstringOptional

The timeout for the verification.

Example: 3
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
post
POST /api/v1/verifications/json-ld HTTP/1.1
Host: 
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"
}
[]
PreviousTAANextSettings

Was this helpful?