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

# Get organization profile

> Returns the authenticated merchant organization profile and account number.



## OpenAPI

````yaml /openapi.json get /v3/profile
openapi: 3.1.0
info:
  title: Sarafa Merchant API
  summary: Enterprise API for Sarafa merchants.
  description: >-
    The Sarafa Merchant API is mounted under `/v3` and authenticated with a
    merchant API secret.
  version: 0.1.0
servers:
  - url: https://serviceapi.sarafa.ss
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Profile
  - name: Wallets
  - name: Money movement
  - name: Transactions
  - name: Rates
paths:
  /v3/profile:
    get:
      tags:
        - Profile
      summary: Get organization profile
      description: >-
        Returns the authenticated merchant organization profile and account
        number.
      operationId: getProfile
      parameters:
        - $ref: '#/components/parameters/EnvironmentHeader'
      responses:
        '200':
          description: Organization profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponse'
              example:
                status: success
                data:
                  organization:
                    name: Acme Ltd
                    description: Merchant account
                    slug: acme
                    logo_url: null
                    website_url: https://example.com
                  account_number: '9020260000001'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    EnvironmentHeader:
      name: environment
      in: header
      required: false
      description: Target environment. Defaults to `production` when omitted.
      schema:
        type: string
        enum:
          - production
          - sandbox
        default: production
  schemas:
    ProfileResponse:
      type: object
      required:
        - status
        - data
      properties:
        status:
          type: string
          enum:
            - success
        data:
          type: object
          required:
            - organization
            - account_number
          properties:
            organization:
              $ref: '#/components/schemas/Organization'
            account_number:
              type: string
    Organization:
      type: object
      required:
        - name
        - slug
      properties:
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        slug:
          type: string
        logo_url:
          type:
            - string
            - 'null'
          format: uri
        website_url:
          type:
            - string
            - 'null'
          format: uri
    ErrorResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum:
            - error
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              value:
                status: error
                message: API key is required
            invalidApiKey:
              value:
                status: error
                message: Invalid API key
    Forbidden:
      description: Organization or account context could not be resolved.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: error
            message: Organization account not found
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: error
            message: Something went wrong. Request could not be processed
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Merchant API secret.

````