---
title: "POST /v1alpha1/badges/verify"
method: POST
path: "/v1alpha1/badges/verify"
tags: ["BadgeService"]
---

# POST /v1alpha1/badges/verify

`POST /v1alpha1/badges/verify`

## Request

- Base URL: `http://localhost:4000`
- URL: `http://localhost:4000/v1alpha1/badges/verify`
- Auth: HTTP bearer and API key in header `x-id-api-key`

Verify a badge.

## Request body

- VerifyBadgeRequest
  - `badge` string: The JOSE enveloped badge to verify.

## Response `200`

OK

- VerificationResult: The result returned from the verification process defined [here] [here]: https://www.w3.org/TR/vc-data-model-2.0/#verification
  - `status` boolean: A boolean status
  - `document` VerifiableCredential: DataModel represents the W3C Verifiable Credential Data Model defined [here] [here]: https://www.w3.org/TR/vc-data-model/
    - `context` string[]: https://www.w3.org/TR/vc-data-model/#contexts
    - `type` string[]: https://www.w3.org/TR/vc-data-model/#dfn-type
    - `issuer` string: https://www.w3.org/TR/vc-data-model/#issuer
    - `credentialSubject` BadgeClaims: BadgeClaims represents the content of a Badge VC defined [here] [here]: https://spec.identity.agntcy.org/docs/vc/intro/
      - `id` string: The ID as defined [here] [here]: https://www.w3.org/TR/vc-data-model/#credential-subject
      - `badge` string: The content of the badge
    - `id` string: https://www.w3.org/TR/vc-data-model/#identifiers
    - `issuanceDate` string: https://www.w3.org/TR/vc-data-model/#issuance-date
    - `expirationDate` string: https://www.w3.org/TR/vc-data-model/#expiration
    - `credentialSchema` CredentialSchema[]: https://www.w3.org/TR/vc-data-model-2.0/#data-schemas
      - `type` string: Type specifies the type of the file
      - `id` string: The URL identifying the schema file
    - `credentialStatus` CredentialStatus[]: https://www.w3.org/TR/vc-data-model-2.0/#status
      - `id` string: The URL identifying the schema file
      - `type` string: Type specifies the type of the file
      - `createdAt` string, date-time: The creation date and time of the status
      - `purpose` 'CREDENTIAL_STATUS_PURPOSE_UNSPECIFIED' | 'CREDENTIAL_STATUS_PURPOSE_REVOCATION', enum: The value of the purpose for the status entry
    - `proof` Proof: A data integrity proof provides information about the proof mechanism, parameters required to verify that proof, and the proof value itself.
      - `type` string: The type of the proof
      - `proofPurpose` string: The proof purpose
      - `proofValue` string: The proof value
  - `mediaType` string: The media type of the Verifiable Credential (ex: application/vc)
  - `controller` string: The controller of the verification method associated with the securing mechanism, usually it represents the issuer.
  - `controlledIdentifierDocument` string: A controlled identifier document that is associated with the verification method used to verify the securing mechanism (i,e the DID)
  - `warnings` ErrorInfo[]: A list represents zero or more warnings generated by the verification process
    - `reason` string
    - `message` string
  - `errors` ErrorInfo[]: A list represents zero or more errors generated by the verification process
    - `reason` string
    - `message` string

## Other responses

- `default`: Default error response

---

[API](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api.md) - [All operations](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agntcy/apis/agntcy-identity-service-api/revisions/1dc8f8328648?raw)