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

# Get operation status

> Alias for `GET /v1/operations/{operationId}`. Returns the current operation state scoped to the signed partner integration.



## OpenAPI

````yaml /openapi/payfi-v1.json get /v1/operations/{operationId}/status
openapi: 3.0.0
info:
  title: PayFi Partner API
  description: >-
    Partner API for PayFi compliance document automation. Dashboard Partner
    access is the admin role for exactly one partner integration; public API
    requests remain authenticated with signed partner API keys.
  version: 0.1.0
  contact: {}
servers:
  - url: https://sandbox.payfi.global
    description: Sandbox
  - url: https://api.payfi.global
    description: Production
security: []
tags:
  - name: Customers
    description: Signed partner endpoints for customer records.
  - name: Operations
    description: Signed partner endpoints for operations, documents, and upload completion.
  - name: Webhooks
    description: Partner-managed webhook endpoints and signed callback tests.
paths:
  /v1/operations/{operationId}/status:
    get:
      tags:
        - Operations
      summary: Get operation status
      description: >-
        Alias for `GET /v1/operations/{operationId}`. Returns the current
        operation state scoped to the signed partner integration.
      operationId: PartnerApiController_getOperationStatus
      parameters:
        - name: operationId
          in: path
          required: true
          description: Operation ID.
          schema:
            type: string
          example: op_example
      responses:
        '200':
          description: Operation status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationStatusResponse'
              examples:
                readyForManualReview:
                  value:
                    operationId: op_example_ready
                    partnerOperationId: acme-op-123
                    customerId: cus_example
                    status: READY_FOR_MANUAL_REVIEW
                    operationType: IMPORT_GOODS
                    exchangeModality: TERM
                    requirementsStatus: APPROVED
                    requiredDocumentTypes:
                      - invoice
                      - bill_of_lading
                      - packing_list
                    missingDocumentTypes: []
                    score0To100: 94
                    score1To10: 10
                    riskLevel: low
                    createdAt: '2026-05-20T12:00:00.000Z'
                    updatedAt: '2026-05-20T12:10:00.000Z'
                actionRequired:
                  value:
                    operationId: op_example_action
                    partnerOperationId: acme-op-123
                    customerId: cus_example
                    status: ACTION_REQUIRED
                    operationType: IMPORT_GOODS
                    exchangeModality: TERM
                    requirementsStatus: APPROVED
                    requiredDocumentTypes:
                      - invoice
                      - bill_of_lading
                      - packing_list
                    missingDocumentTypes:
                      - invoice
                    score0To100: 22
                    score1To10: 3
                    riskLevel: critical
                    createdAt: '2026-05-20T12:00:00.000Z'
                    updatedAt: '2026-05-20T12:10:00.000Z'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidRequest:
                  value:
                    error:
                      code: INVALID_REQUEST
                      message: The request payload is invalid.
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  value:
                    error:
                      code: UNAUTHORIZED
                      message: Authentication failed.
      security:
        - PayFiApiKey: []
          PayFiNonce: []
          PayFiSignature: []
components:
  schemas:
    OperationStatusResponse:
      type: object
      properties:
        operationId:
          type: string
          example: op_example
        partnerOperationId:
          type: string
          nullable: true
          example: acme-op-123
        customerId:
          type: string
          nullable: true
          example: cus_example
        status:
          type: string
          enum:
            - CREATED
            - REQUIREMENTS_PENDING
            - REQUIREMENTS_REVIEW_REQUIRED
            - REQUIREMENTS_FAILED
            - AWAITING_DOCUMENTS
            - DOCUMENTS_PARTIAL
            - DOCUMENTS_UPLOADED
            - PROCESSING
            - PROCESSING_FAILED
            - ACTION_REQUIRED
            - READY_FOR_MANUAL_REVIEW
            - MANUAL_REVIEW_APPROVED
            - MANUAL_REVIEW_REJECTED
            - MANUAL_REVIEW_CHANGES_REQUESTED
            - PARTNER_CALLBACK_PENDING
            - PARTNER_CALLBACK_DELIVERED
            - PARTNER_CALLBACK_FAILED
            - CANCELLED
            - FAILED
          example: REQUIREMENTS_REVIEW_REQUIRED
        operationType:
          type: string
          enum:
            - IMPORT_GOODS
            - EXPORT_GOODS
            - SERVICES
          example: IMPORT_GOODS
        exchangeModality:
          type: string
          enum:
            - ADVANCE
            - SIGHT
            - TERM
          example: TERM
        requirementsStatus:
          type: string
          enum:
            - PENDING
            - REVIEW_REQUIRED
            - APPROVED
            - FAILED
          example: REVIEW_REQUIRED
        requiredDocumentTypes:
          type: array
          items:
            type: string
            enum:
              - invoice
              - bill_of_lading
              - packing_list
              - di_duimp
              - bank_details
              - proforma
              - service_contract
              - insurance_policy
            example: invoice
          example:
            - invoice
            - bill_of_lading
            - packing_list
        missingDocumentTypes:
          type: array
          items:
            type: string
            enum:
              - invoice
              - bill_of_lading
              - packing_list
              - di_duimp
              - bank_details
              - proforma
              - service_contract
              - insurance_policy
            example: invoice
          example:
            - invoice
        score0To100:
          type: number
          nullable: true
          example: null
        score1To10:
          type: number
          nullable: true
          example: null
        riskLevel:
          type: string
          enum:
            - low
            - medium
            - high
            - critical
            - unknown
          nullable: true
          example: null
        declaredBeneficiaryName:
          type: string
          nullable: true
          example: Shenzhen NovaTech Components Co Ltd
        declaredEconomicOwnerName:
          type: string
          nullable: true
          example: Shenzhen NovaTech Components Co Ltd
        buyerCountry:
          type: string
          nullable: true
          example: BR
        createdAt:
          type: string
          example: '2026-05-20T12:00:00.000Z'
        updatedAt:
          type: string
          example: '2026-05-20T12:00:00.000Z'
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: INVALID_SIGNATURE
            message:
              type: string
              example: The request signature is invalid.
  securitySchemes:
    PayFiApiKey:
      type: apiKey
      in: header
      name: X-PayFi-Api-Key
    PayFiNonce:
      type: apiKey
      in: header
      name: X-PayFi-Nonce
    PayFiSignature:
      type: apiKey
      in: header
      name: X-PayFi-Signature

````