Civic

Civic Piirequest API

Get user PII and approve / reject receipt of PII

Documentation GitHub OpenAPI

Operations 2

GET /piirequest/{scopeRequestId} Get the user's PII using a ScopeRequestId provided by Civic #

PUT /piirequest/{scopeRequestId}/status Approve or Reject receipt of PII, to allow or block issuance of the user's… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/civic-piirequest-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Civic Pass Customer Piirequest API
  description: The APIs described below enable Civic customers to issue and manage the Civic Pass for their dApp.
  termsOfService: https://www.civic.com/legal/terms-of-service-civic-pass-v1/
  contact:
    email: devsupport@civic.com
  version: 1.0.0
servers:
- url: https://api.civic.com/partner
tags:
- name: piirequest
  description: Get user PII and approve / reject receipt of PII
paths:
  /piirequest/{scopeRequestId}:
    get:
      tags:
      - piirequest
      summary: Get the user's PII using a ScopeRequestId provided by Civic
      operationId: getPii
      description: After the user's PII has been delivered to Civic, we give you an ID (scopeRequestId) that can be used to retrieve the user's PII before issuing the Civic Pass.
      parameters:
      - name: scopeRequestId
        in: path
        description: The ID that was provided to you by Civic after the user has submitted their PII
        required: true
        example: 9a7a77af-a58e-4e54-83c9-5daa96ccbf11
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPiiResponse'
  /piirequest/{scopeRequestId}/status:
    put:
      tags:
      - piirequest
      summary: Approve or Reject receipt of PII, to allow or block issuance of the user's…
      operationId: updatePiiReceipt
      description: After you reviewed the user's PII returned by the GET /piirequest/{scopeRequestId} endpoint, you can approve or reject the user's Civic Pass by calling this endpoint.
      parameters:
      - name: scopeRequestId
        in: path
        description: The ID that was provided to you by Civic after the user has submitted their PII
        required: true
        example: 9a7a77af-a58e-4e54-83c9-5daa96ccbf11
        schema:
          type: string
      - name: status
        in: body
        description: Set this to 'partner-pass' to approve the issuance of the user's Civic Pass, or 'partner-fail' to reject it.
        schema:
          type: string
          enum:
          - partner-pass
          - partner-fail
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                  - partner-pass
                  - partner-fail
                  description: Whether to approve (pass) or reject (fail) the issuance of the user's Civic Pass.
              required:
              - status
      responses:
        200:
          description: OK
components:
  schemas:
    GetPiiResponse:
      type: object
      properties:
        status:
          description: The status of this PII request. The PII can be retrieved once this has reached 'verification-success'
          type: string
          enum:
          - awaiting-user
          - user-acknowledged
          - verification-success
          - verification-failed
          - user-cancelled
          - partner-pass
          - partner-fail
        verifiedInformation:
          type: object
          description: A set of all the user's PII that Civic could verify. The exact set of fields will differ depending on your pass configuration.
          example:
            email: user@example.com
            documentType: passport
            issueCountry: GBR
            name: First Middle Last
            dateOfBirth: '1990-01-01'
            dateOfExpiry: '2035-05-28'
            documentNumber: 0123456789
            address: '0x1234abcd'
        links:
          type: array
          description: A list of the evidence item URLs collected from the user.
          items:
            type: object
            properties:
              rel:
                type: string
                example: idDocumentFront
              href:
                type: string
                example: https://api.civic.com/partner/piirequest/9a7a77af-a58e-4e54-83c9-5daa96ccbf11
  securitySchemes:
    pass_auth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth0.civic.com/oauth/token
          scopes: {}