> ## Documentation Index
> Fetch the complete documentation index at: https://developers.mypilotindex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check a certificate or MPI Report

> Verifies an MPI Report certificate by its public id and answers exactly what the public verification at /v1/public/certificates/{certificate_id} answers: the public view of a certificate that is not revoked (the holder's name as printed on it, the score and percentile at issue, the phase, the highest class, the stored status, and the issue and expiry instants), never the holder's account or contact. The id is trimmed and upper-cased; an unknown, revoked or malformed id answers 404 not_found, the three alike. status is the stored one: compare expires_at with the current time to show expiry by date. The call needs no grant and no scope; like every partner call it counts toward the daily allowance and is logged.



## OpenAPI

````yaml /api-reference/partner.yaml get /v1/partner/certificates/{certificate_id}
openapi: 3.1.0
info:
  title: MyPilotIndex Partner API
  version: 1.0.0
  description: >-
    The API of approved partner applications, such as logbooks, that act for a
    pilot who has granted them access on the MyPilotIndex consent screen. It is
    a separate document from the member API (openapi.yaml): partner routes live
    under /v1/partner/ and are never served to browsers. Authenticate with an
    access token from the identity provider's token endpoint
    (grant_type=client_credentials, scopes partner/<scope>) in the Authorization
    header. Every authenticated answer carries X-RateLimit-Limit and
    X-RateLimit-Remaining, the partner's daily allowance and what is left of it
    (a 401, and a path or method outside this document, carry neither); past the
    allowance the API answers 429 rate_limited with Retry-After. Errors use the
    shared envelope below. The API is additive within v1: new fields and routes
    may appear, existing ones do not change meaning.
servers:
  - url: https://{devApiHost}
    description: >-
      Sandbox on the AWS dev environment, with synthetic pilots. The host is
      issued to the partner with its sandbox credential.
    variables:
      devApiHost:
        default: dev-api.mypilotindex.com
        description: The dev API host given to the partner with the sandbox credential.
security: []
tags:
  - name: Grants
    description: >-
      A pilot connects on MyPilotIndex: the partner sends his browser to the
      consent page
      (https://mypilotindex.com/connect/{slug}?client_id&redirect_uri&scope&state&code_challenge&code_challenge_method=S256),
      the pilot signs in and allows, and the browser returns to the registered
      redirect_uri with code and state (or error=access_denied and state when he
      denies). The partner exchanges the code here for a grant and the pilot's
      pairwise id, which signs the pilot in ("Sign in with MyPilotIndex") and
      names him on every later call. A grant that is revoked, unknown or another
      partner's answers 404 on every route, identically.
  - name: Certificates
    description: >-
      Check a certificate a pilot shows you, such as his MPI Report, by its
      public id. The answer is the public verification's, and the call needs no
      grant.
  - name: Webhooks
    description: >-
      MyPilotIndex tells a partner about its grants by webhook: grant.revoked
      when a grant ends, and ping when the partner asks for a test. The webhook
      URL (https only) and its signing secret are set by MyPilotIndex when the
      partner is approved; the secret is shown once. Each event is a POST of the
      event as JSON (Content-Type application/json) signed in the Standard
      Webhooks scheme: webhook-id (the event id), webhook-timestamp and
      webhook-signature, "v1," and the base64 HMAC-SHA256 of
      "<webhook-id>.<webhook-timestamp>.<body>" under the key the secret carries
      in base64 after its whsec_ prefix, over the exact bytes received. Verify
      the signature, refuse a timestamp more than five minutes from your clock,
      dedupe on webhook-id, and answer any 2xx within 10 seconds. A 5xx, a 408,
      a 429, a redirect (never followed), a timeout or a connection failure is
      retried with growing gaps for about a day (twelve attempts), with the same
      webhook-id and a fresh timestamp and signature. A 4xx other than 408 and
      429 is taken as a refusal and not retried, except for a grant.revoked
      event with reason account_deleted: its grant leaves every list with the
      account, so it cannot be reconciled later, and it is retried within the
      same window on any answer but a 2xx, a 4xx included. A partner that missed
      other events reconciles with GET
      /v1/partner/grants?status=revoked&changed_since=.
paths:
  /v1/partner/certificates/{certificate_id}:
    get:
      tags:
        - Certificates
      summary: Check a certificate or MPI Report
      description: >-
        Verifies an MPI Report certificate by its public id and answers exactly
        what the public verification at /v1/public/certificates/{certificate_id}
        answers: the public view of a certificate that is not revoked (the
        holder's name as printed on it, the score and percentile at issue, the
        phase, the highest class, the stored status, and the issue and expiry
        instants), never the holder's account or contact. The id is trimmed and
        upper-cased; an unknown, revoked or malformed id answers 404 not_found,
        the three alike. status is the stored one: compare expires_at with the
        current time to show expiry by date. The call needs no grant and no
        scope; like every partner call it counts toward the daily allowance and
        is logged.
      operationId: partners.verify_certificate.v1
      parameters:
        - name: certificate_id
          in: path
          required: true
          description: >-
            The public certificate id: MPI, the four-digit year, the class
            (AMEL, AMES, ASEL, ASES or GENL) and a sequence of six to nine
            digits, joined by hyphens (MPI-2026-AMEL-000412). Surrounding
            whitespace is ignored and letters are upper-cased; anything longer
            than 64 bytes or outside the issued format is treated as unknown.
          schema:
            type: string
      responses:
        '200':
          description: The public view of the certificate.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CertificateVerification'
              example:
                certificate_id: MPI-2026-AMEL-000412
                pilot_name: Ana Souza
                score_at_issue: 512.4
                percentile_at_issue: 70
                score_category: Positioning
                phase_color: '#fbbf24'
                highest_class: AMEL
                status: active
                issued_at: '2026-01-02T03:04:05Z'
                expires_at: '2027-01-02T03:04:05Z'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          description: not_found; the id is unknown, revoked or outside the issued format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: not_found
                  message: Resource not found.
                  correlation_id: 0af7651916cd43dd8448eb211c80319c
        '405':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
        '504':
          $ref: '#/components/responses/Error'
      security:
        - partnerOAuth: []
components:
  headers:
    RateLimitLimit:
      description: >-
        The partner's daily allowance of calls (1,000 unless agreed otherwise),
        per UTC day.
      schema:
        type: integer
    RateLimitRemaining:
      description: What is left of the allowance after this call.
      schema:
        type: integer
    RetryAfter:
      description: >-
        The HTTP date, in UTC, when the allowance renews (the next UTC
        midnight).
      schema:
        type: string
        example: Thu, 05 Nov 2026 00:00:00 GMT
  schemas:
    CertificateVerification:
      type: object
      additionalProperties: false
      required:
        - certificate_id
        - pilot_name
        - score_at_issue
        - percentile_at_issue
        - score_category
        - phase_color
        - highest_class
        - status
        - issued_at
        - expires_at
      description: >-
        The public view of an MPI Report certificate, the answer of the public
        verification.
      properties:
        certificate_id:
          type: string
        pilot_name:
          type: string
          description: The holder's name as printed on the certificate.
        score_at_issue:
          type: number
        percentile_at_issue:
          type: integer
          minimum: 0
          maximum: 100
        score_category:
          type: string
        phase_color:
          type: string
        highest_class:
          type: string
          enum:
            - AMEL
            - AMES
            - ASEL
            - ASES
            - GENL
        status:
          type: string
          enum:
            - active
            - expired
          description: >-
            The stored status; compare expires_at with the current time to show
            expiry by date.
        issued_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - correlation_id
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - request_too_large
                - unauthenticated
                - not_found
                - conflict
                - unprocessable
                - operation_disabled
                - rate_limited
                - forbidden
                - dependency_unavailable
                - internal
                - deadline_exceeded
                - method_not_allowed
            message:
              type: string
              description: Stable safe English message, never the underlying error text.
            correlation_id:
              type: string
              pattern: ^[a-f0-9]{32}$
            reason:
              type: string
              description: Optional refusal reason from the operation's closed vocabulary.
    RateLimitedError:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            error:
              type: object
              properties:
                reason:
                  type: string
                  enum:
                    - rate_limited
  responses:
    Error:
      description: The shared error envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        rate_limited with reason rate_limited, past the partner's daily
        allowance; nothing was done.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitedError'
  securitySchemes:
    partnerOAuth:
      type: oauth2
      description: >-
        OAuth 2.0 client credentials. Request a token from the token endpoint of
        the identity provider's domain (https://{cognito-domain}/oauth2/token,
        with HTTP Basic client authentication) and send it as a Bearer token.
        Production uses auth.mypilotindex.com. The sandbox uses the dev
        environment's Cognito domain, which is given to the partner with its
        sandbox credential. A token carries only the scopes the partner was
        approved for.
      flows:
        clientCredentials:
          tokenUrl: https://auth.mypilotindex.com/oauth2/token
          scopes:
            partner/profile: Read the pilot's name, photo and username.
            partner/score: Read the pilot's MPI Score and phase.
            partner/hours.read: Read the pilot's flight hours.
            partner/hours.write: Update the pilot's flight hours with the logbook's totals.
            partner/licenses: Read the pilot's licenses, ratings and type ratings.
            partner/applications: Read the pilot's applications to jobs from the partner's company.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.