Skip to content

Get a verification

Identity module

GET/verifications/{id}verifications.get

A verification badge, shown only after the platform or a provider checks the claim. Returns one verification with its `ETag`. A verification the caller may not see returns 404.

  • Requires the capability people.directory.read.
  • OAuth scopes: people.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

verifications.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the verification.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: Verification

verifications.get: Verification
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the verification.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
verified_atstring (date-time) | nullYesWhen it was verified.
method"Stripe Identity" | "Business Registry"YesHow the organization was verified.
provider_referencestringYesThe provider's verification or registry record reference.Constraints: length 1 to 300
expires_atstring (date-time) | nullYesWhen the verification lapses; null when it does not.
revoked_atstring (date-time) | nullYesWhen the platform revoked it.
revocation_reasonstring | nullYesWhy it was revoked.Constraints: length 1 to 20000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "verified_at": "2026-10-08T14:30:00Z",
  "method": "Stripe Identity",
  "provider_reference": "vs_1Pq2Rs3Tu4",
  "expires_at": "2026-10-08T14:30:00Z",
  "revoked_at": "2026-10-08T14:30:00Z",
  "revocation_reason": "The registry record lapsed."
}

Code samples

curl -X GET "$XOS_BASE_URL/verifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.verifications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.verifications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos verifications get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f