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

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# Retrieve Customer

> Looks up a customer profile by an identifier (email address or phone number).
The controller auto-detects the type: if the identifier contains '@', it searches by email hash; otherwise, it searches by phone number hash.
On success, returns the fully decrypted PII details of the customer.




## OpenAPI

````yaml /api/merchant_api.yaml get /customers/{identifier}
openapi: 3.1.0
info:
  title: OwnPay Merchant API
  description: >
    The OwnPay Merchant API enables merchants to programmatically interface with
    their white-labeled payment gateway.

    It exposes endpoints to initiate payments (creating payment intents), query
    transaction statuses, issue full or partial refunds, manage customer
    profiles securely in compliance with GDPR and OWASP, generate and revoke API
    keys, and test/audit webhook delivery attempts.


    ### Authentication

    Authentication is performed via HTTP Bearer token in the `Authorization`
    header.

    ```http

    Authorization: Bearer your_api_key_here

    ```

    API keys carry specific privilege scopes (e.g., `read`, `write`, `admin`).

    Some administrative operations (like listing/generating API keys) require
    **both** `write` and `admin` scopes, as well as passing a valid platform
    super-administrator's email address in the `X-Super-Admin-Email` header for
    safety.
  version: 1.0.0
servers:
  - url: https://{brand_domain}/api/v1
    description: Sandbox or Production white-labeled brand gateway API server.
    variables:
      brand_domain:
        default: ownpay.org
        description: The custom domain configured for your white-labeled brand.
security:
  - BearerAuth: []
paths:
  /customers/{identifier}:
    get:
      summary: Retrieve Customer
      description: >
        Looks up a customer profile by an identifier (email address or phone
        number).

        The controller auto-detects the type: if the identifier contains '@', it
        searches by email hash; otherwise, it searches by phone number hash.

        On success, returns the fully decrypted PII details of the customer.
      operationId: retrieveCustomer
      parameters:
        - name: identifier
          in: path
          required: true
          description: The URL-encoded email address or phone number of the customer.
          schema:
            type: string
      responses:
        '200':
          description: Customer decrypted details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerDetailsResponse'
        '404':
          description: Customer not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSingleErrorResponse'
        '422':
          description: Identifier was empty or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSingleErrorResponse'
components:
  schemas:
    CustomerDetailsResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            id:
              type: integer
              example: 58
            uuid:
              type: string
              format: uuid
              example: 83b9c9d2-b2f4-4df1-bc1e-b810d1c810d1
            name:
              type: string
              example: Alice Smith
            email:
              type: string
              format: email
              example: alice@example.com
            phone:
              type: string
              example: '+8801800000000'
            created_at:
              type: string
              format: date-time
              example: '2026-06-23T14:15:45Z'
    ApiSingleErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          example: Payment not found
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: PAYMENT_NOT_FOUND
              message:
                type: string
                example: Payment not found
              field:
                type: string
                nullable: true
                example: null
        request_id:
          type: string
          example: 8f5a2e9b0c7d4e5f
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Provide the Bearer API Key generated for your brand.

````

## Related topics

- [Retrieve Payment Details](/docs/api-reference/retrieve-payment-details.md)
- [Retrieve SMS Filter Rules](/docs/api-reference/retrieve-sms-filter-rules.md)
- [Retrieve Refund](/docs/api-reference/retrieve-refund.md)
- [Retrieve Transaction](/docs/api-reference/retrieve-transaction.md)
- [Retrieve Dashboard Summary](/docs/api-reference/retrieve-dashboard-summary.md)