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

# Get check



## OpenAPI

````yaml /openapi/blacklist.json get /v1/blacklist/check/
openapi: 3.0.3
info:
  title: Yume API — Чёрный список
  version: 1.0.0
  description: Внешний blacklist-сервис.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/blacklist/check/:
    get:
      tags:
        - check
      summary: Get check
      operationId: check_list
      parameters:
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: pageSize
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBlacklistIdentityList'
          description: ''
      security:
        - jwtAuth: []
        - {}
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedBlacklistIdentityList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/BlacklistIdentity'
    BlacklistIdentity:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        canonical_name:
          type: string
          maxLength: 255
        canonical_iin:
          type: string
          nullable: true
          maxLength: 12
        canonical_bin:
          type: string
          nullable: true
          maxLength: 12
        canonical_phone:
          type: string
          nullable: true
          maxLength: 32
        reports_count:
          type: integer
          maximum: 2147483647
          minimum: 0
        needs_review:
          type: boolean
        records:
          type: array
          items:
            $ref: '#/components/schemas/BlacklistIdentityRecord'
          readOnly: true
      required:
        - canonical_name
        - id
        - records
    BlacklistIdentityRecord:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        company_name:
          type: string
          readOnly: true
        company_type:
          type: string
          readOnly: true
        comment:
          type: string
          nullable: true
          maxLength: 512
        added_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          maxLength: 255
        phone:
          type: string
          nullable: true
          maxLength: 32
        iin:
          type: string
          nullable: true
          maxLength: 16
          minLength: 12
        bin:
          type: string
          nullable: true
          maxLength: 16
          minLength: 12
        photo:
          type: string
          format: uri
          nullable: true
      required:
        - added_at
        - company_name
        - company_type
        - id
        - name
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````