Identity Type service

The Identity Type service in Identity Management Framework can be used to retrieve, create, update and delete an identifier in the platform. Additionally this service allows owners to manage permissions for their identity solutions. Using this service, identity owners can:

• Determine the publisher(s) that are permitted to utilize their identifier within the bidstream.
• Decide the partner(s) on the platform who can incorporate data using their identifier.
• Choose the external bidder(s) who are eligible to access their identifier.
• Select the partner(s) on the platform who are eligible to receive the identifier's value in their log level data feeds.

REST API

JSON fields

Registration fields with admin-only control

The master control settings for an identifier owner

Auction participation control

The master setting to control whether other publishers can employ this identifier and specify the ones who are permitted to do so. This field in request defines list of member for which auction is enabled. Auction enabled members become the participants for an identifier in the framework.

Audience segmentation control

The master setting to control permissions to other members for audience segmentation using the identifier. This field in request defines list of members for which segment onboarding is allowed for the registered identifier.

External bidder control

The master setting to control if the identifier can be sent to the external bidders and specify the eligible external bidders. This field defines default list of bidders who will be receiving the newly registered source and identifier. By default, member participants can use the bidders defined at the identifier level or they can override using the identity type participant API.

Log-level data exposure control

The master setting to regulate if the identifier can be utilized in log-level data (LLD) and determine the authorized recipients. This field defines the list of members who will be able see actual ID values in LLD feed for the newly registered source and identifier. By default, member participants can use the members defined at the identifier level or they can override the identity type participant API where publishers have the option to utilize the participant service to exert additional control over how the identifier they provide is employed and surfaced by the platform.

Examples

Create an identifier

$ cat new_identifier.json
{
  "identity_type": {
      "source": "test.com",
      "member_owner_id": 958,
      "requires_platform_resolution": true,
      "identity_resolver_check": true,
      "is_auction_usage_single_context": true,
      "is_passthrough": true,
      "requires_seat_resolution": false,
      "requires_rti_partner_match": false,
      "rti_partner": "",
      "is_experimental": false,
      "opt_out_default": false,
      "status": "active",
      "enforce_adx_specification": false,
      "auction_participation_control": {
        "allow_participation": "include_subset",
        "participant_member_list": [
          123,
          456
        ]
      },
      "audience_segmentation_control": {
        "allow_segmentation": "include_subset",
        "segmentation_member_list": [
          456
        ]
      },
      "external_bidder_control": {
        "allow_bidders": "all",
        "external_bidder_list": [
          111,
          112
        ]
      },
      "lld_exposure_control": {
        "lld_exposure_allowed": "include_subset",
        "exposure_member_list": [
          311,
          312
        ]
      }
    }
  }
$ curl -b cookie -c cookie -X POST  'https://api.appnexus.com/identity-type'
{
    "response": {
        "status":"OK",
        "id":IDENTITY_ID_001
        }
        }

View the details of a specific identifier

$ curl -b cookies -c cookies 'https://api.appnexus.com/identity-type?id=IDENTITY_ID_001'
{
  "response": {
    "status": "OK",
    "identity_type": {
        "id": IDENTITY_ID_001,
        "source": "test.com",
        "member_owner_id": 958,
        "requires_platform_resolution": true,
        "identity_resolver_check": true,
        "is_auction_usage_single_context": true,
        "is_passthrough": true,
        "requires_seat_resolution": false,
        "requires_rti_partner_match": false,
        "rti_partner": "",
        "is_experimental": false,
        "opt_out_default": false,
        "status": "active",
        "enforce_adx_specification": false,
        "auction_participation_control": {
          "allow_participation": "include_subset",
          "participant_member_list": [
            123,
            456
          ]
        },
        "audience_segmentation_control": {
        "allow_segmentation": "include_subset",
        "segmentation_member_list": [
          456
         ]
        },
        "external_bidder_control": {
        "allow_bidders": "all",
        "external_bidder_list": [
          111,
          112
         ]
        },
        "lld_exposure_control": {
        "lld_exposure_allowed": "include_subset",
        "exposure_member_list": [
          311,
          312
        ]
      }
    }
  }
}

Related topic

Identity Type Participant Service