Skip to main content
API docs by Redocly

VeriMe API (1.0.0)

Download OpenAPI specification:Download

Auditable, voucher-backed verification API providing isPerson and hasPresence determinations using a local VeriFactCache synchronized from SumSub outputs.

Verification

Determine whether a subject is a verified person.

Authorizations:
SubscriberHMAC
Request Body schema: application/json
required
invocationId
required
string

ULID supplied by subscriber to ensure idempotency.

localAccountId
required
string

Subscriber foreign key linking to invoker.

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "invocationId": "01HZYBZQ5PSTVZ7KJ8ABCD12",
  • "localAccountId": "localacct-7890",
  • "subject": {
    },
  • "verificationContext": {
    }
}

Response samples

Content type
application/json
{
  • "verificationOutcome": {
    },
  • "maskedFact": {
    },
  • "receipt": {
    }
}

Evaluate subject presence confidence across recent activity.

Authorizations:
SubscriberHMAC
Request Body schema: application/json
required
invocationId
required
string

ULID supplied by subscriber to ensure idempotency.

localAccountId
required
string

Subscriber foreign key linking to invoker.

required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "invocationId": "01HZYBZQ5PSTVZ7KJ8ABCD12",
  • "localAccountId": "localacct-7890",
  • "subject": {
    },
  • "verificationContext": {
    }
}

Response samples

Content type
application/json
{
  • "verificationOutcome": {
    },
  • "maskedFact": {
    },
  • "receipt": {
    }
}

Vouchers

Issue one-time verification vouchers.

Authorizations:
SubscriberHMAC
Request Body schema: application/json
required
quantity
required
integer [ 1 .. 1000 ]
voucherProduct
required
string
localAccountId
required
string
expiresAt
string <date-time>
memo
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 1,
  • "voucherProduct": "string",
  • "localAccountId": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "memo": "string"
}

Response samples

Content type
application/json
{
  • "issuedVouchers": [
    ],
  • "receipt": {
    }
}

Redeem a voucher for verification usage.

Authorizations:
SubscriberHMAC
Request Body schema: application/json
required
voucherCode
required
string
localAccountId
required
string
invocationId
string
intent
string
Enum: "isPerson" "hasPresence"

Responses

Request samples

Content type
application/json
{
  • "voucherCode": "string",
  • "localAccountId": "string",
  • "invocationId": "string",
  • "intent": "isPerson"
}

Response samples

Content type
application/json
{
  • "status": "redeemed",
  • "maskedVoucher": "***-1A0D",
  • "linkedReceiptId": "01HZYCDQ8X9K4WYH7S9Q4QYB9F",
  • "receipt": {
    }
}

Purchase additional voucher balance.

Authorizations:
SubscriberHMAC
Request Body schema: application/json
required
voucherProduct
required
string
quantity
required
integer >= 1
required
object

Responses

Request samples

Content type
application/json
{
  • "voucherProduct": "string",
  • "quantity": 1,
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "creditedQuantity": 100,
  • "balanceAfter": 450,
  • "receipt": {
    }
}

Retrieve voucher inventory overview.

Authorizations:
SubscriberHMAC
query Parameters
localAccountId
string

Subscriber-defined local account foreign key.

Responses

Response samples

Content type
application/json
{
  • "summary": [
    ],
  • "receipt": {
    }
}

Inspect voucher status using masked voucher token.

Authorizations:
SubscriberHMAC
path Parameters
voucherCode
required
string

Masked voucher token reference (e.g., ***-AB12).

Responses

Response samples

Content type
application/json
{
  • "maskedVoucher": "***-1A0D",
  • "status": "redeemed",
  • "issuedAt": "2024-08-30T12:00:00Z",
  • "expiresAt": "2024-09-30T00:00:00Z",
  • "linkedInvocationId": "01HZYBZQ5PSTVZ7KJ8ABCD12",
  • "receipt": {
    }
}

Receipts

List receipts for subscriber.

Authorizations:
SubscriberHMAC
query Parameters
from
string <date-time>
to
string <date-time>
localAccountId
string

Subscriber-defined local account foreign key.

operation
string
Enum: "isPerson" "hasPresence" "voucher.issue" "voucher.redeem" "voucher.purchase"
page
integer >= 1
Default: 1
pageSize
integer [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "receipt": {
    }
}

Retrieve a specific receipt.

Authorizations:
SubscriberHMAC
path Parameters
receiptId
required
string

ULID referencing receipt entry.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "receipt": {
    }
}

Reports

Fetch aggregated verification metrics.

Authorizations:
SubscriberHMAC
query Parameters
from
required
string <date-time>
to
required
string <date-time>
localAccountId
string

Subscriber-defined local account foreign key.

voucherProduct
string

Voucher product tier identifier.

groupBy
Array of strings
Items Enum: "localAccountId" "voucherProduct" "result" "countryCode" "confidenceBand"

Responses

Response samples

Content type
application/json
{
  • "report": {
    },
  • "receipt": {
    }
}

Fetch aggregated voucher usage metrics.

Authorizations:
SubscriberHMAC
query Parameters
from
required
string <date-time>
to
required
string <date-time>
voucherProduct
string

Voucher product tier identifier.

Responses

Response samples

Content type
application/json
{
  • "report": {
    },
  • "receipt": {
    }
}

Operations

Inspect VeriFactCache synchronization status.

Authorizations:
SubscriberHMAC

Responses

Response samples

Content type
application/json
{
  • "currentSnapshot": {
    },
  • "syncStatus": {
    },
  • "receipt": {
    }
}