Osano

Osano Subjects API

The Subjects API from Osano — 9 operation(s) for subjects.

GitHub OpenAPI

Operations 9

GET /v2/subjects/{subjectRef} Get subjects by subject ref #
POST /v2/subjects/merge Create subjects merge #
POST /v2/subjects/profile/verify Create subjects profile verify #
POST /v2/subjects/profile/verify/sms Create subjects profile verify sms #
GET /v2/subjects/{id}/profile Get subjects by id profile #
POST /v2/subjects/send-code Create subjects send code #
POST /v2/subjects/send-code/sms Create subjects send code sms #
POST /v2/subjects/profile/verification-code Create subjects profile verification code #
POST /v2/subjects/profile Create subjects profile #

Documentation

📖
Documentation
https://developers.osano.com/customer-rest-api/developer-api-doc
📖
APIReference
https://developers.osano.com/customer-rest-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/authentication/osano-authentication.yml
📖
Documentation
https://developers.osano.com/uc/
📖
APIReference
https://developers.osano.com/uc/core-api/openapi

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/openapi/osano-subjects-api-openapi.yml

SDKs

📦
SDK
https://developers.osano.com/uc/js-sdk/

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/errors/osano-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/data-model/osano-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/conventions/osano-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osano-subjects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osano-subjects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Unified Consent Core Subjects API
  description: '> **📍 Regional Distribution**

    > The UC Core API is regionally distributed.'
  version: 2.0.0
servers:
- url: https://uc.api.osano.com
security:
- ucApiKey: []
tags:
- name: Subjects
paths:
  /v2/subjects/{subjectRef}:
    get:
      description: Retrieves subject by id or from a valid session
      parameters:
      - schema:
          type: string
          enum:
          - subject
          - session
        in: query
        name: ref
        required: false
        description: Indicates what type of reference is provided for the subject. Supports a subject id or a session id.
      - schema:
          type: string
        in: path
        name: subjectRef
        required: true
        description: Anonymous id, verified id, or a valid session id.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  verifiedId:
                    type: string
                  anonymousId:
                    type: string
      tags:
      - Subjects
      summary: Get subjects by subject ref
      x-summary-source: derived
      operationId: getV2SubjectsBySubjectRef
      x-operation-id-source: derived
  /v2/subjects/merge:
    post:
      description: Merge subjects (an anonymous and a verified)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - sourceSubjectId
              - targetSubjectId
              properties:
                sourceSubjectId:
                  type: string
                  minLength: 1
                targetSubjectId:
                  type: string
                  minLength: 1
        required: true
      parameters:
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: string
                pattern: OK
      tags:
      - Subjects
      summary: Create subjects merge
      x-summary-source: derived
      operationId: postV2SubjectsMerge
      x-operation-id-source: derived
  /v2/subjects/profile/verify:
    post:
      description: Verify a subject profile using Email
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              - code
              properties:
                email:
                  type: string
                  minLength: 1
                  format: email
                  normalizeEmail: true
                code:
                  type: string
                  minLength: 6
                  maxLength: 6
        required: true
      parameters:
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  verifiedId:
                    type: string
      tags:
      - Subjects
      summary: Create subjects profile verify
      x-summary-source: derived
      operationId: postV2SubjectsProfileVerify
      x-operation-id-source: derived
  /v2/subjects/profile/verify/sms:
    post:
      description: Verify a subject profile using SMS
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - phone
              - code
              - session
              properties:
                phone:
                  type: string
                  minLength: 1
                  phone: true
                code:
                  type: string
                  minLength: 8
                  maxLength: 8
                session:
                  type: string
                  minLength: 1
        required: true
      parameters:
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  verifiedId:
                    type: string
      tags:
      - Subjects
      summary: Create subjects profile verify sms
      x-summary-source: derived
      operationId: postV2SubjectsProfileVerifySms
      x-operation-id-source: derived
  /v2/subjects/{id}/profile:
    get:
      description: Get a subject profile
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    type: string
                  subjectId:
                    type: string
      tags:
      - Subjects
      summary: Get subjects by id profile
      x-summary-source: derived
      operationId: getV2SubjectsByIdProfile
      x-operation-id-source: derived
  /v2/subjects/send-code:
    post:
      description: Sends a verification email to a subject
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  minLength: 1
                  format: email
                  normalizeEmail: true
        required: true
      parameters:
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      responses:
        '200':
          description: Default Response
      tags:
      - Subjects
      summary: Create subjects send code
      x-summary-source: derived
      operationId: postV2SubjectsSendCode
      x-operation-id-source: derived
  /v2/subjects/send-code/sms:
    post:
      description: Send a verification text to a subject
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - phone
              properties:
                phone:
                  type: string
                  minLength: 1
                  phone: true
        required: true
      parameters:
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      responses:
        '200':
          description: Default Response
      tags:
      - Subjects
      summary: Create subjects send code sms
      x-summary-source: derived
      operationId: postV2SubjectsSendCodeSms
      x-operation-id-source: derived
  /v2/subjects/profile/verification-code:
    post:
      description: Create profile verification code
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  minLength: 1
                  format: email
                  normalizeEmail: true
        required: true
      parameters:
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      security:
      - osanoApiKey: []
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
      tags:
      - Subjects
      summary: Create subjects profile verification code
      x-summary-source: derived
      operationId: postV2SubjectsProfileVerificationCode
      x-operation-id-source: derived
  /v2/subjects/profile:
    post:
      description: Create and insert a subject profile
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                  normalizeEmail: true
                phone:
                  type: string
                  phone: true
                profile:
                  type: object
      parameters:
      - schema:
          type: string
          enum:
          - subject
          - session
        in: query
        name: resultType
        required: false
      - schema:
          type: string
          enum:
          - application/json
        in: header
        name: content-type
        required: true
        description: The payload is a valid serialized JSON object
      security:
      - osanoApiKey: []
      responses:
        '200':
          description: Default Response
      tags:
      - Subjects
      summary: Create subjects profile
      x-summary-source: derived
      operationId: postV2SubjectsProfile
      x-operation-id-source: derived
components:
  securitySchemes:
    ucApiKey:
      description: Unified Consent API key
      type: apiKey
      name: x-uc-api-key
      in: header
    osanoApiKey:
      description: Osano API key
      type: apiKey
      name: x-osano-api-key
      in: header