layercall-com Device API

openapi: 3.2.0
info:
  title: LayerCall Device API
  version: 1.0.0
  summary: Trust and risk intelligence for IPs, emails, phones, domains and devices.
  description: 'Score any IP address, email, phone number, domain or device — or a whole signup in one call — and get back a 0–100 risk score plus an allow / review / block verdict.


    Authenticate with an API key from https://www.layercall.com/get-key. Free tier: 1,000 lookups per month, no card required. Test-mode keys are never billed.


    Every endpoint accepts an optional `strictness` parameter (`lenient`, `balanced`, `strict`) that shifts the verdict thresholds without changing the underlying signals.'
  termsOfService: https://www.layercall.com/terms
  contact:
    name: LayerCall Support
    email: support@layercall.com
    url: https://www.layercall.com/contact
  license:
    name: Proprietary
    url: https://www.layercall.com/terms
  x-logo:
    url: https://www.layercall.com/logo-icon.png
    altText: LayerCall
servers:
- url: https://www.layercall.com
  description: Production
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: Device
  description: Fingerprint reputation and bot detection.
paths:
  /v1/score/device:
    post:
      tags:
      - Device
      operationId: scoreDevice
      summary: Score a device fingerprint
      description: 'Reputation and bot probability for a browser fingerprint produced by https://www.layercall.com/fp.js.


        This is the signal that survives an attacker rotating IPs and email addresses: a new VPN exit and a fresh disposable inbox are free, a new machine is not. The `device_id` is hashed in the browser and again before storage, so the stored value cannot be reversed to a device.


        POST rather than GET because a device id in a query string ends up in access logs and Referer headers.'
      parameters:
      - $ref: '#/components/parameters/Strictness'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - device_id
              properties:
                device_id:
                  type: string
                  description: Hex fingerprint from LayerCall.fingerprint().
                  example: ff48aa64a243c1b9e07d5c2f8a1b4e6d9c3f7a2b5e8d1c4f7a0b3e6d9c2f5a8b
                ip:
                  type: string
                  description: Visitor IP. Optional — enables the timezone-vs-geolocation check.
                  example: 185.220.101.5
                signals:
                  type: object
                  description: Optional browser characteristics from fp.js. Used for bot scoring only, never persisted.
                  properties:
                    user_agent:
                      type: string
                    timezone:
                      type: string
                      example: Europe/Berlin
                    timezone_offset:
                      type: integer
                    screen:
                      type: string
                      example: 1920x1080x24
                    hardware_concurrency:
                      type: integer
                    languages:
                      type: string
                    webgl_renderer:
                      type: string
                automation:
                  type: object
                  description: Optional automation markers from fp.js.
                  properties:
                    webdriver:
                      type: boolean
                      description: navigator.webdriver was true.
                    automation_globals:
                      type: boolean
                      description: Selenium/Puppeteer/Playwright globals present.
                    headless_ua:
                      type: boolean
                    zero_screen:
                      type: boolean
                    no_plugins:
                      type: boolean
                    no_languages:
                      type: boolean
      responses:
        '200':
          description: Device score
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceScore'
          headers:
            x-ratelimit-limit:
              description: Requests allowed per minute (600).
              schema:
                type: integer
            x-ratelimit-remaining:
              description: Requests left in the current minute.
              schema:
                type: integer
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    DeviceScore:
      type: object
      required:
      - device_id
      - risk_score
      - verdict
      - bot_probability
      - signals
      properties:
        device_id:
          type: string
        risk_score:
          $ref: '#/components/schemas/RiskScore'
        verdict:
          $ref: '#/components/schemas/Verdict'
        bot_probability:
          type: integer
          minimum: 0
          maximum: 100
          description: 'Reported separately from risk: plenty of automated traffic is legitimate.'
        signals:
          type: object
          properties:
            is_bot:
              type: boolean
              description: bot_probability >= 60.
            is_automated:
              type: boolean
            is_headless:
              type: boolean
            timezone_mismatch:
              type:
              - boolean
              - 'null'
              description: Browser timezone country differs from the IP's. Silent (false) when either is genuinely unknown; null when the country could NOT be resolved — a GeoIP outage — so no comparison was made.
            repeat_device:
              type: boolean
              description: Seen before across the LayerCall network.
        first_seen:
          type:
          - string
          - 'null'
          format: date-time
        times_seen:
          type: integer
        abuse_reports:
          type: integer
        request_id:
          type: string
          example: req_9319c108-cc66-4cbf-af64-37729a17c855
        processing_time_sec:
          type: number
          example: 0.031
        billable_lookups:
          type: integer
          example: 1
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable message, safe to log.
    RiskScore:
      type: integer
      minimum: 0
      maximum: 100
      description: 0 = clean, 100 = certain fraud.
    Verdict:
      type: string
      enum:
      - allow
      - review
      - block
      description: Recommended action. Thresholds move with `strictness`.
  parameters:
    Strictness:
      name: strictness
      in: query
      required: false
      schema:
        type: string
        enum:
        - lenient
        - balanced
        - strict
        default: balanced
      description: Shifts the allow/review/block thresholds. Signals and risk_score are unchanged.
  responses:
    RateLimited:
      description: Monthly quota or spend cap reached, or the 600 requests-per-minute rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        x-ratelimit-limit:
          description: Requests allowed per minute (600).
          schema:
            type: integer
        x-ratelimit-remaining:
          description: Requests left in the current minute.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Missing or malformed input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key from https://www.layercall.com/get-key
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Same key, sent as `Authorization: Bearer <key>`.'
externalDocs:
  description: Guides and examples
  url: https://www.layercall.com/docs