openapi: 3.2.0
info:
  contact:
    name: API Support
    email: support@getpliant.com
    url: https://www.getpliant.com
  title: Pliant Customer Card Copilots API
  description: Pliant Customer API
  version: 2.1.0
  license:
    name: MIT
    url: https://opensource.org/license/MIT
servers:
- url: https://partner-api.getpliant.com/api
  description: Pliant Production Server
- url: https://sandbox.partner-api.getpliant.com/api
  description: Pliant Sandbox Server
- url: https://pci-api.getpliant.com
  description: PCI Vault Production Server
- url: https://pci-sandbox.partner-api.getpliant.com
  description: PCI Vault Sandbox Server
security:
- bearerAuth: []
tags:
- name: Card Copilots
  description: This tag is for operations related to card copilots
paths:
  /cards/copilots/subscription:
    post:
      summary: 'Callback: Add/Update'
      description: Subscribe to callbacks for this entity or change an existing callback.
      tags:
      - Card Copilots
      operationId: create-card-copilot-subscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                callbackUrl:
                  type: string
                  format: uri
                  example: https://myserver.com/send/callback/here
                  description: The URL to send the callback to. Must be a valid and reachable URL. We do some basic validation to ensure the URL is syntactically correct and reachable for Pliant. Only HTTPS URLs are supported.
                eventTypes:
                  type: array
                  items:
                    type: string
                    description: 'The event types to subscribe to.

                      '
                    enum:
                    - CARD_COPILOT_CHANGED
              required:
              - callbackUrl
              - eventTypes
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      callbacks:
        cardCopilotChanged:
          '{$request.body#/callbackUrl}':
            post:
              parameters:
              - in: header
                name: X-Organization-Id
                schema:
                  type: string
                  format: uuid
                  description: 'Referencing the organization this callback was sent for. See [guides](/docs/callbacks) for more details. Example value: `54e6e7e7-0c23-4a54-bccb-2d3ff2fd02df`.'
              - in: header
                name: X-Partner-Organization-Id
                schema:
                  type: string
                  description: 'Filled, if the value `partnerOrganizationId` is [set](/reference/update-organization) by the partner on the organization itself. Referencing the organization identifier of the partner. Example value: `abc123`.'
              - in: header
                name: X-Payment-Program-Id
                schema:
                  type: string
                  format: uuid
                  description: 'Referencing the payment program this callback was sent for. See [guides](/docs/callbacks) for more details. Example value: `54e6e7e7-0c23-4a54-bccb-2d3ff2fd02df`.'
              - in: header
                name: X-Callback-Id
                schema:
                  type: string
                  format: uuid
                  description: 'A unique identifier for this callback. Can be used to deduplicate callbacks to achieve idempotent behavior. See [guides](/docs/callbacks) for more details. Example value: `12a03093-eaad-4ae5-9d8d-42e7f6f8b7c6`.'
              - in: header
                name: X-Callback-Created-At
                schema:
                  type: string
                  format: date-time
                  description: 'The date and time when the callback was created. Can be used to reorder callbacks. See [guides](/docs/callbacks) for more details. Example value: `2024-03-15T15:55:58.623375258Z`.'
              requestBody:
                content:
                  application/json:
                    schema:
                      allOf:
                      - $ref: '#/paths/~1cards~1subscription/post/callbacks/cardUpdated/{$request.body#~1callbackUrl}/post/requestBody/content/application~1json/schema/allOf/0'
                      - type: object
                        properties:
                          cardId:
                            type: string
                            format: uuid
                            description: The unique identifier of the card.
                          cardAccountId:
                            type:
                            - string
                            - 'null'
                            format: uuid
                            description: The unique identifier of the card account this card belongs to.
                          cardholderId:
                            type: string
                            format: uuid
                            description: The ID of the cardholder assigned to the card.
                          copilots:
                            type: object
                            description: The copilot also has access to the card and its card details alongside with the cardholder of the card itself.
                            properties:
                              cardholderIds:
                                type: array
                                items:
                                  type: string
                                  format: uuid
                                description: The IDs of the cardholders assigned as copilots to the card.
                              teamIds:
                                type: array
                                items:
                                  type: string
                                  format: uuid
                                description: The IDs of the teams assigned as copilots to the card.
              responses:
                '200':
                  description: We expect the partner to return a HTTP 200 status code if the callback was successfully received. On 4xx and 5xx status codes, we will [retry](/docs/callbacks#retries) the callback.
    delete:
      summary: 'Callback: Remove'
      description: Remove a callback subscription for this entity.
      tags:
      - Card Copilots
      operationId: remove-card-copilot-subscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                eventTypes:
                  type: array
                  description: The event types to unsubscribe from.
                  items:
                    type: string
                    enum:
                    - CARD_COPILOT_CHANGED
              required:
              - eventTypes
      responses:
        '200':
          description: Ok
  /cards/{cardId}/copilots:
    put:
      summary: Update Card Copilots
      description: 'Update the copilots of a specific card. The cardholder and the copilots have access to the card and its card details.

        You need to provide all copilots you want to assign to the card. Copilots that are not provided will be removed from the card.


        **Note: the copilots feature is available for `TRAVEL` cards only.**'
      tags:
      - Card Copilots
      operationId: update-card-copilots
      parameters:
      - name: cardId
        in: path
        required: true
        description: The unique identifier of the card.
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cardholderIds:
                  type:
                  - array
                  - 'null'
                  items:
                    type: string
                    format: uuid
                  description: The IDs of the cardholders to assign as copilots to the card.
                teamIds:
                  type:
                  - array
                  - 'null'
                  items:
                    type: string
                    format: uuid
                  description: The IDs of the teams to assign as copilots to the card.
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  cardId:
                    type: string
                    format: uuid
                    description: The ID of the card.
                  copilots:
                    type:
                    - object
                    - 'null'
                    description: The copilot also has access to the card and its card details alongside with the cardholder.
                    properties:
                      cardholderIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                        description: The IDs of the cardholders assigned as copilots to the card.
                      teamIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                        description: The IDs of the teams assigned as copilots to the card.
        '400':
          $ref: '#/paths/~1cards/get/responses/400'
        '401':
          $ref: '#/paths/~1cards/get/responses/401'
        '403':
          $ref: '#/paths/~1cards/get/responses/403'
        '404':
          $ref: '#/paths/~1cards/post/responses/404'
        '429':
          $ref: '#/paths/~1cards/get/responses/429'
        '500':
          $ref: '#/paths/~1cards/get/responses/500'
  /cards/{cardId}/copilots/claim:
    put:
      summary: Claim Card As Copilot
      description: 'Claim a card to become the new cardholder for this card. You need to be a copilot of the respective card to claim the card.


        **Note: the copilots feature is available for `TRAVEL` cards only.**'
      tags:
      - Card Copilots
      operationId: claim-card-as-copilot
      parameters:
      - name: cardId
        in: path
        required: true
        description: The unique identifier of the card.
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                cardholderId:
                  type: string
                  format: uuid
                  description: The ID of the cardholder to assign as the new cardholder of the card.
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  cardId:
                    type: string
                    format: uuid
                    description: The ID of the card.
                  cardholderId:
                    type: string
                    format: uuid
                    description: The ID of the cardholder assigned as the new cardholder of the card.
                  copilots:
                    type:
                    - object
                    - 'null'
                    description: The copilot also has access to the card and its card details alongside with the cardholder of the card itself.
                    properties:
                      cardholderIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                        description: The IDs of the cardholders assigned as copilots to the card.
                      teamIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                        description: The IDs of the teams assigned as copilots to the card.
        '400':
          $ref: '#/paths/~1cards/get/responses/400'
        '401':
          $ref: '#/paths/~1cards/get/responses/401'
        '403':
          $ref: '#/paths/~1cards/get/responses/403'
        '404':
          $ref: '#/paths/~1cards/post/responses/404'
        '429':
          $ref: '#/paths/~1cards/get/responses/429'
        '500':
          $ref: '#/paths/~1cards/get/responses/500'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: This API uses oAuth2 with client credentials flow to [obtain the Bearer Token](/docs/authenticated-api-usage).
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://customer-api.getpliant.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://customer-api.getpliant.com/reference/activate-physical-card.md
  - https://customer-api.getpliant.com/reference/assign-project-team.md
  - https://customer-api.getpliant.com/reference/assign-to-team.md
  - https://customer-api.getpliant.com/reference/bulk-upsert-subscriptions.md
  - https://customer-api.getpliant.com/reference/card-pan-and-cvv-pci-vault.md
  - https://customer-api.getpliant.com/reference/card-pan-tokenized-from-pci-proxy.md
  - https://customer-api.getpliant.com/reference/claim-card-as-copilot.md
  - https://customer-api.getpliant.com/reference/create-account-entry-subscription.md
  - https://customer-api.getpliant.com/reference/create-accounting-project-subscription.md
  - https://customer-api.getpliant.com/reference/create-accounting-team-subscription.md
  - https://customer-api.getpliant.com/reference/create-accounting-transaction-subscription.md
  - https://customer-api.getpliant.com/reference/create-card-account-subscription.md
  - https://customer-api.getpliant.com/reference/create-card-account-transfer.md
  - https://customer-api.getpliant.com/reference/create-card-account.md
  - https://customer-api.getpliant.com/reference/create-card-copilot-subscription.md
  - https://customer-api.getpliant.com/reference/create-card-subscription.md
  - https://customer-api.getpliant.com/reference/create-cardholder-subscription.md
  - https://customer-api.getpliant.com/reference/create-custom-field-option.md
  - https://customer-api.getpliant.com/reference/create-custom-field.md
  - https://customer-api.getpliant.com/reference/create-payment-subscription.md
  - https://customer-api.getpliant.com/reference/create-project.md
  - https://customer-api.getpliant.com/reference/create-receipt-automatching-subscription.md
  - https://customer-api.getpliant.com/reference/create-receipt-subscription.md
  - https://customer-api.getpliant.com/reference/create-statement-subscription.md
  - https://customer-api.getpliant.com/reference/create-team.md
  - https://customer-api.getpliant.com/reference/create-transaction-subscription.md
  - https://customer-api.getpliant.com/reference/deactivate-card-account.md
  - https://customer-api.getpliant.com/reference/deactivate-cardholder.md
  - https://customer-api.getpliant.com/reference/deactivate-team.md
  - https://customer-api.getpliant.com/reference/delete-custom-field-option.md
  - https://customer-api.getpliant.com/reference/delete-custom-field.md
  - https://customer-api.getpliant.com/reference/delete-project.md
  - https://customer-api.getpliant.com/reference/delete-receipt.md
  - https://customer-api.getpliant.com/reference/delete-subscription.md
  - https://customer-api.getpliant.com/reference/delete-team.md
  - https://customer-api.getpliant.com/reference/delete-transaction-comment.md
  - https://customer-api.getpliant.com/reference/generate-test-transactions-in-sandbox.md
  - https://customer-api.getpliant.com/reference/get-account-entries.md
  - https://customer-api.getpliant.com/reference/get-accounting-transactions-batch.md
  - https://customer-api.getpliant.com/reference/get-available-cards.md
  - https://customer-api.getpliant.com/reference/get-callback-details.md
  - https://customer-api.getpliant.com/reference/get-callback-log.md
  - https://customer-api.getpliant.com/reference/get-callback-subscriptions.md
  - https://customer-api.getpliant.com/reference/get-callback.md
  - https://customer-api.getpliant.com/reference/get-card-account-details.md
  - https://customer-api.getpliant.com/reference/get-card-accounts-available-currencies.md
  - https://customer-api.getpliant.com/reference/get-card-accounts.md
  - https://customer-api.getpliant.com/reference/get-card-controls-by-card.md
  - https://customer-api.getpliant.com/reference/get-card-pin.md
  - https://customer-api.getpliant.com/reference/get-cardholder-details.md
  - https://customer-api.getpliant.com/reference/get-cards.md
  - https://customer-api.getpliant.com/reference/get-custom-field-options.md
  - https://customer-api.getpliant.com/reference/get-custom-fields.md
  - https://customer-api.getpliant.com/reference/get-multiple-card-details.md
  - https://customer-api.getpliant.com/reference/get-organization-details.md
  - https://customer-api.getpliant.com/reference/get-otp-for-pci-widget.md
  - https://customer-api.getpliant.com/reference/get-payments-detail.md
  - https://customer-api.getpliant.com/reference/get-payments.md
  - https://customer-api.getpliant.com/reference/get-projects.md
  - https://customer-api.getpliant.com/reference/get-receipt-automatcher-status.md
  - https://customer-api.getpliant.com/reference/get-receipt-detail.md
  - https://customer-api.getpliant.com/reference/get-receipts.md
  - https://customer-api.getpliant.com/reference/get-single-card-details.md
  - https://customer-api.getpliant.com/reference/get-statement-csv.md
  - https://customer-api.getpliant.com/reference/get-statement-detail.md
  - https://customer-api.getpliant.com/reference/get-statementpdf.md
  - https://customer-api.getpliant.com/reference/get-statements.md
  - https://customer-api.getpliant.com/reference/get-teams.md
  - https://customer-api.getpliant.com/reference/get-transactions-detail-batch.md
  - https://customer-api.getpliant.com/reference/get-transactions-detail.md
  - https://customer-api.getpliant.com/reference/get-transactions.md
  - https://customer-api.getpliant.com/reference/invite-cardholders.md
  - https://customer-api.getpliant.com/reference/issue-card-instant-with-pci.md
  - https://customer-api.getpliant.com/reference/issue-card-instant.md
  - https://customer-api.getpliant.com/reference/issue-card.md
  - https://customer-api.getpliant.com/reference/list-cardholders.md
  - https://customer-api.getpliant.com/reference/list-organizations.md
  - https://customer-api.getpliant.com/reference/load-cards-batch.md
  - https://customer-api.getpliant.com/reference/lock-card.md
  - https://customer-api.getpliant.com/reference/metadata-receipt-to-automatcher.md
  - https://customer-api.getpliant.com/reference/receipt-as-merged-pdf.md
  - https://customer-api.getpliant.com/reference/receipt-as-pdf.md
  - https://customer-api.getpliant.com/reference/receipt-original.md
  - https://customer-api.getpliant.com/reference/receipt-thumbnail.md
  - https://customer-api.getpliant.com/reference/register-cardholders.md
  - https://customer-api.getpliant.com/reference/remove-account-entry-subscription.md
  - https://customer-api.getpliant.com/reference/remove-accounting-project-subscription.md
  - https://customer-api.getpliant.com/reference/remove-accounting-team-subscription.md
  - https://customer-api.getpliant.com/reference/remove-accounting-transaction-subscription.md
  - https://customer-api.getpliant.com/reference/remove-card-account-subscription.md
  - https://customer-api.getpliant.com/reference/remove-card-copilot-subscription.md
  - https://customer-api.getpliant.com/reference/remove-cardholder-subscription.md
  - https://customer-api.getpliant.com/reference/remove-cards-subscription.md
  - https://customer-api.getpliant.com/reference/remove-payment-subscription.md
  - https://customer-api.getpliant.com/reference/remove-receipt-automatching-subscription.md
  - https://customer-api.getpliant.com/reference/remove-receipt-subscription.md
  - https://customer-api.getpliant.com/reference/remove-statement-subscription.md
  - https://customer-api.getpliant.com/reference/remove-transaction-subscription.md
  - https://customer-api.getpliant.com/reference/replace-card.md
  - https://customer-api.getpliant.com/reference/resend-callbacks.md
  - https://customer-api.getpliant.com/reference/search-callbacks.md
  - https://customer-api.getpliant.com/reference/simulate-prefund-payment.md
  - https://customer-api.getpliant.com/reference/simulate-transaction-status-transition.md
  - https://customer-api.getpliant.com/reference/terminate-card.md
  - https://customer-api.getpliant.com/reference/unassign-from-team.md
  - https://customer-api.getpliant.com/reference/unassign-project-team.md
  - https://customer-api.getpliant.com/reference/unlock-card.md
  - https://customer-api.getpliant.com/reference/update-card-account.md
  - https://customer-api.getpliant.com/reference/update-card-controls-by-card.md
  - https://customer-api.getpliant.com/reference/update-card-copilots.md
  - https://customer-api.getpliant.com/reference/update-card-label.md
  - https://customer-api.getpliant.com/reference/update-card-limit.md
  - https://customer-api.getpliant.com/reference/update-card-validity-period.md
  - https://customer-api.getpliant.com/reference/update-card.md
  - https://customer-api.getpliant.com/reference/update-cardholders.md
  - https://customer-api.getpliant.com/reference/update-custom-field-option.md
  - https://customer-api.getpliant.com/reference/update-custom-field.md
  - https://customer-api.getpliant.com/reference/update-custom-fields-on-accounting-transaction.md
  - https://customer-api.getpliant.com/reference/update-custom-fields-on-card.md
  - https://customer-api.getpliant.com/reference/update-project.md
  - https://customer-api.getpliant.com/reference/update-team.md
  - https://customer-api.getpliant.com/reference/update-transaction-category.md
  - https://customer-api.getpliant.com/reference/update-transaction-comment.md
  - https://customer-api.getpliant.com/reference/update-transaction-partner-submission-status-batch.md
  - https://customer-api.getpliant.com/reference/update-transaction-partner-submission-status.md
  - https://customer-api.getpliant.com/reference/update-transaction-receipt-upload.md
  - https://customer-api.getpliant.com/reference/upload-receipt-to-automatcher.md
  - https://customer-api.getpliant.com/reference/upload-receipt.md
  merge:
    pages: 128
    deduped: 452
    conflicts_kept_first: 0