Sift API

openapi: 3.1.0
info:
  title: Sift API
  version: '2026-10-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-26: 11 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Sift has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 13
    documentation: -2
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.sift.com/docs/v204/curl/events-api
  - https://developers.sift.com/docs/v204/curl/mobile-sdk
paths:
  /v203/events:
    post:
      operationId: post_v203_events
      tags:
      - Events
      summary: POST /v203/events
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: return_action
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV203EventsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV203EventsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.sift.com/v203/events?return_action=true\n-H \"Accept: application/json\"\n-d '{\n \"$api_key\": \"\
          YOUR_SANDBOX_REST_API_KEY\",\n \"$type\": \"$create_order\",\n \"$user_id\": \"test_user\"\n}'\n import sift\nclient = sift.Client(\"\
          YOUR_API_KEY\")"
  /v204/events:
    post:
      operationId: post_v204_events
      tags:
      - Events
      summary: POST /v204/events
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV204EventsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST -H \"Content-Type: application/json\" -d '{\"$api_key\": \"YOUR_API_KEY\", \"$type\": \"$login\", \"$user_id\"\
          : \"123456\"}' https://api.sift.com/v204/events \n Authorization Header Authentication : Set the HTTP header Authorization to Basic\
          \ {base64_encode(api_key + \":\")} . This requires encoding your API key followed by a colon (\":\") using Base64. "
  /v204/score/{useridhere}:
    get:
      operationId: get_v204_score_useridhere
      tags:
      - Score
      summary: GET /v204/score/{userIdHere}
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: useridhere
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i \"https://api.sift.com/v204/score/USER_ID_HERE /?api_key=YOUR_API_KEY\"\n import sift\nclient = sift.Client(\"YOUR_API_KEY\"\
          )\nresponse = client.score(\"USER_ID_HERE\")\n require \"sift\"\nclient = Sift::Client.new(:api_key => \"YOUR_API_KEY\")\nresponse =\
          \ client.score(\"USER_ID_HERE\")\n require 'sift-php/lib/Services_JSON-1.0.3/JSON.php';\nrequire 'sift-php/lib/SiftRequest.php';\nrequire\
          \ 'sift-php/lib/SiftRe"
  /v204/users/{insertuserid}/labels:
    get:
      operationId: get_v204_users_insertuserid_labels
      tags:
      - Users
      summary: GET /v204/users/{insertUserId}/labels
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: insertuserid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl example below for a concrete example. \n When acting on behalf of a Merchant \n When performing actions at the level of\
          \ a specific existing merchant account, use the API key\nassociated with that merchant (which is included in the response when the merchant's\
          \ Sift\naccount is first created). When using the existing\n Events API or\n Labels API this will mean\nplacing this API key into the\
          \ JSON body."
    post:
      operationId: post_v204_users_insertuserid_labels
      tags:
      - Users
      summary: POST /v204/users/{insertUserId}/labels
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: insertuserid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.sift.com/v204/users/INSERT_USER_ID/labels -d \\n'{\n \"$api_key\" : \"YOUR_API_KEY\",\n \"$is_fraud\"\
          \ : true,\n \"$abuse_type\" : \"payment_abuse\",\n \"$description\" : \"The user was testing cards repeatedly for a valid card\",\n\
          \ \"$source\" : \"manual review\",\n \"$analyst\" : \"someone@your-site.com\"\n}'"
  /v204/users/{userid}/labels:
    delete:
      operationId: delete_v204_users_userid_labels
      tags:
      - Users
      summary: DELETE /v204/users/{userId}/labels
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      - name: abuse_type
        in: query
        required: false
        schema:
          type: string
      - name: api_key
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X DELETE "https://api.sift.com/v204/users/USER_ID/labels/?api_key=YOUR_API_KEY&abuse_type=payment_abuse" import sift

          client = sift.Client("YOUR_API_KEY - production key if not testing")

          response = client.unlabel("billy_jones_301", abuse_type="payment_abuse") require "sift"

          client = Sift::Client.new(:api_key => "YOUR_API_KEY - production key if not testing")

          response = client.unlabel("billy_j'
  /v3/accounts/{accountid}/devices/{deviceid}/label:
    put:
      operationId: put_v3_accounts_accountid_devices_deviceid_label
      tags:
      - Accounts
      summary: Label a Device PUT   /v3/accounts/{accountId}/devices/{deviceId}/label
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: accountid
        in: path
        required: true
        schema:
          type: string
      - name: deviceid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV3AccountsAccountidDevicesDeviceidLabelRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV3AccountsAccountidDevicesDeviceidLabelResponse'
      x-evidence:
        kind: documentation
  /v3/accounts/{accountid}/sessions/{sessionid}:
    get:
      operationId: get_v3_accounts_accountid_sessions_sessionid
      tags:
      - Accounts
      summary: Session Information GET   /v3/accounts/{accountId}/sessions/{sessionId}
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: accountid
        in: path
        required: true
        schema:
          type: string
      - name: sessionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV3AccountsAccountidSessionsSessionidResponse'
      x-evidence:
        kind: documentation
  /v3/accounts/{accountid}/users/{userid}/devices:
    get:
      operationId: get_v3_accounts_accountid_users_userid_devices
      tags:
      - Accounts
      summary: Device Information for Users GET   /v3/accounts/{accountId}/users/{userId}/devices
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: accountid
        in: path
        required: true
        schema:
          type: string
      - name: userid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV3AccountsAccountidUsersUseridDevicesResponse'
      x-evidence:
        kind: documentation
  /v3/accounts/{accountId}/decisions:
    get:
      operationId: get_v3_accounts_accountId_decisions
      tags:
      - Accounts
      summary: Getting available decisions $ curl -XGET https://api.sift.com/v3/accounts/{account_id}/decisions
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
      - name: entity_type
        in: query
        required: false
        schema:
          type: string
        description: Entity type filter
      - name: abuse_types
        in: query
        required: false
        schema:
          type: string
        description: Comma-separated abuse types
      - name: from
        in: query
        required: false
        schema:
          type: integer
        description: Pagination start index
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum results
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV3AccountsAccountidDecisionsResponse'
      x-evidence:
        kind: documentation
  /v3/accounts/{id}/devices/{id}:
    post:
      operationId: post_v3_accounts_id_devices_id
      tags:
      - Accounts
      summary: POST /v3/accounts/{id}/devices/{id}
      x-source: https://developers.sift.com/docs/v204/curl/events-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV3AccountsIdDevicesIdRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV3AccountsIdDevicesIdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -XGET 'https://api.sift.com/v3/accounts/{id}/devices/{id}' \\n -H 'Content-Type: application/json' \\n -u {YOUR_API_KEY}:\
          \ Example Response {\n \"id\" : \"{id}\",\n \"label\" : \"bad\",\n \"labeled_at\" : 1241241214000,\n \"first_seen\" : 1412990802000,\n\
          \ \"users\" : {\n \"data\" : [ {\n \"id\" : \"bob123\",\n \"href\" : \"https://api.sift.com/v3/accounts/{id}/users/bob123\"\n } ]\n\
          \ },\n \"network\" : {\n \"first_seen\" : 141238603300"
components:
  schemas:
    PostV203EventsRequest:
      type: object
      properties:
        $api_key:
          type: string
        $type:
          type: string
        $user_id:
          type: string
    PostV203EventsResponse:
      type: object
      properties:
        $api_key:
          type: string
        $type:
          type: string
        $user_id:
          type: string
    PostV204EventsRequest:
      type: object
      properties:
        $api_key:
          type: string
        $type:
          type: string
        $user_id:
          type: string
    PutV3AccountsAccountidDevicesDeviceidLabelRequest:
      type: object
      properties:
        label:
          type: string
          description: bad or not_bad
      required:
      - label
    PutV3AccountsAccountidDevicesDeviceidLabelResponse:
      type: object
      properties:
        label:
          type: string
          description: Returned label
    GetV3AccountsAccountidSessionsSessionidResponse:
      type: object
      properties:
        id:
          type: integer
          description: Session ID
        time:
          type: integer
          description: Session start time
        device:
          type: object
          description: Device data
    GetV3AccountsAccountidUsersUseridDevicesResponse:
      type: object
      properties:
        data:
          type: array
          description: List of device references
    GetV3AccountsAccountidDecisionsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of decisions
    PostV3AccountsIdDevicesIdRequest:
      type: object
      properties:
        label:
          type: string
    PostV3AccountsIdDevicesIdResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              href:
                type: string
tags:
- name: Accounts
- name: Events
- name: Score
- name: Users