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

# Get Customers

> Fetches list of all customers. Can be filtered by passing `customerId`



## OpenAPI

````yaml /api_reference/onramp.yaml get /customers
openapi: 3.0.3
info:
  version: '1.0'
  title: Crypto API
  description: Reference for Sardine Crypto API
  contact:
    email: support@sardine.io
    name: Sardine
    url: docs.sardine.io
servers:
  - url: https://api.sandbox.sardine.ai/v1
    description: Sandbox
  - url: https://api.sardine.ai/v1
    description: Prod Server
security: []
paths:
  /customers:
    get:
      tags:
        - User Onboarding
      summary: Get Customers
      description: Fetches list of all customers. Can be filtered by passing `customerId`
      operationId: get-customers
      parameters:
        - name: customer_id
          in: query
          description: ID of Customer
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Customer'
      security:
        - ClientToken: []
      servers:
        - url: https://api.sandbox.sardine.ai/v1
          description: Sandbox
        - url: https://api.sardine.ai/v1
          description: Prod Server
components:
  schemas:
    Customer:
      type: object
      title: Customer
      properties:
        sessionKey:
          type: string
          minLength: 1
        level:
          type: string
          enum:
            - low
            - medium
            - high
            - very_high
          description: >-
            This is the ONLY field that a merchant needs to use to make decision
            on fraud. This field is set by our rules and the main rule is the
            rule using our "customer score" model.
          minLength: 1
        status:
          type: string
          enum:
            - Success
            - Failure
          minLength: 1
        customer:
          type: object
          properties:
            score:
              type: number
              description: >-
                ML Risk Score for the current customer session. The ML model
                used to predict the score is trained on velocity and aggregation
                features, phone, email, bank, tax, card, IP, location, device
                and behavior intelligence signals. The score can be used once
                feedback for historical transactions has been provided.
            level:
              type: string
              enum:
                - low
                - medium
                - high
                - very_high
              description: This field is based on the signals sent in the response.
              minLength: 1
            signals:
              type: array
              description: >-
                See
                https://docs.sardine.ai/api/reference/operation/v1-customers/
              minItems: 1
              uniqueItems: true
              items:
                type: object
                properties:
                  key:
                    type: string
                    minLength: 1
                  value:
                    type: string
                    minLength: 1
        transaction:
          type: object
          properties:
            level:
              type: string
              enum:
                - low
                - medium
                - high
              description: transaction risk level
              minLength: 1
            amlLevel:
              type: string
              enum:
                - low
                - medium
                - high
              description: aml risk level
              minLength: 1
            indemnification:
              type: object
              properties:
                decision:
                  type: string
                  enum:
                    - approved
                    - conditionally_approved
                    - rejected
                    - unknown
                  minLength: 1
                instantLimit:
                  type: number
                  description: >-
                    This is the withdrawal amount in cents that is immediately
                    available to the end-user. The remaining hold amount should
                    be kept on hold on your side until the time specified by
                    holdTime parameter below.
                holdAmount:
                  type: number
                  description: >-
                    This is the remaining amount in cents that is available
                    after the hold time is over. The hold time + instantLimit is
                    the total deposit amount.
                verificationCode:
                  type: string
                  minLength: 1
                holdTime:
                  type: string
                  description: >-
                    UNIX timestamp that represents time until you which should
                    hold part of fund
                  format: time
      x-examples:
        example-1:
          sessionKey: string
          level: string
          status: string
          customer:
            score: 0
            level: string
            signals:
              - key: string
                value: string
          transaction:
            level: string
            amlLevel: string
            indemnification:
              decision: string
              instantLimit: 0
              holdAmount: 0
              verificationCode: string
          checkpoints:
            customer:
              customerPurchaseLevel:
                value: string
                ruleIds:
                  - {}
              emailLevel:
                value: string
                ruleIds:
                  - {}
              historicalLevel:
                value: string
                ruleIds:
                  - {}
              riskLevel:
                value: string
                ruleIds:
                  - {}
  securitySchemes:
    ClientToken:
      type: http
      scheme: basic

````