Inspect buyer-agent configuration and readiness
curl --request GET \
--url https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/administration \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/administration"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/administration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"principal": {
"principalId": "<string>",
"displayName": "<string>",
"lifecycleState": "active",
"activeCredentialCount": 4503599627370495
},
"readback": {
"kind": "current",
"principal_id": "<string>",
"principal_kind": "buyer_agent",
"configuration_version": "<string>",
"configuration": {
"notification_configs": [
{
"subscriber_id": "<string>",
"url": "<string>",
"event_types": [
"scheduled"
],
"all_authorized_accounts": true,
"include_future_event_types": true,
"authentication": {
"schemes": [
"Bearer"
]
},
"active": true,
"ext": {}
}
],
"reporting_destinations": [
{
"destination_id": "<string>",
"destination_ref": "<string>",
"state": "validating",
"configuration": {
"pattern": "file_transfer",
"destination_id": "<string>",
"active": true,
"provider": {
"domain": "<string>"
},
"transport": "<string>",
"location": "<string>",
"accepted_formats": [
"jsonl"
],
"accepted_verification_profiles": [
"native_commit"
],
"operator_id": "<string>"
},
"prior_destination_refs": [
"<string>"
],
"setup": {
"action": "grant_access",
"setup_url": "<string>",
"expires_at": "<string>"
},
"issues": [
{
"code": "<string>",
"message": "<string>",
"buyer_reason": {
"code": "<string>",
"message": "<string>"
},
"field": "<string>",
"suggestion": "<string>",
"retry_after": 1800.5,
"issues": [
{
"pointer": "<string>",
"message": "<string>",
"keyword": "<string>",
"schemaPath": "<string>",
"schema_id": "<string>",
"discriminator": [
{
"property_name": "<string>",
"value": "<string>"
}
]
}
],
"details": {},
"recovery": "transient",
"source": "producer",
"sdk_id": "<string>"
}
]
}
],
"declarations": {
"declared": {
"async_adcp_versions": [
"<string>"
],
"webhook_signing_algorithms": [
"ed25519"
],
"experimental_features": [
"<string>"
]
},
"accepted": {
"async_adcp_versions": [
"<string>"
],
"webhook_signing_algorithms": [
"ed25519"
],
"experimental_features": [
"<string>"
]
},
"selected_async_adcp_version": "<string>",
"exclusions": [
{
"axis": "async_adcp_versions",
"value": "<string>",
"reason": "<string>"
}
]
},
"retired_destinations": [
{
"destination_id": "<string>",
"destination_refs": [
"<string>"
],
"revoked_at": "<string>"
}
]
}
},
"proof": {
"notificationEndpoints": [
{
"subscriberId": "<string>",
"desiredActive": true,
"proofState": "pending",
"verifiedAt": "2023-11-07T05:31:56Z",
"failureCode": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"reportingDestinations": [
{
"destinationId": "<string>",
"destinationRef": "<string>",
"generation": 4503599627370495,
"pattern": "file_transfer",
"desiredActive": true,
"setupState": "validating",
"proofState": "not_attempted",
"lifecycle": "current",
"revokedAt": "2023-11-07T05:31:56Z"
}
],
"reportingDestinationsTruncated": true
},
"stateFeed": [
{
"transitionId": "<string>",
"event": "principal.changed",
"scope": "principal",
"reason": "principal_suspended",
"repairTask": "get_principal",
"occurredAt": "2023-11-07T05:31:56Z"
}
],
"stateFeedTruncated": true,
"auditFeed": [
{
"auditId": "<string>",
"control": "deactivate_destination",
"targetId": "<string>",
"actor": {
"userId": "<string>",
"email": "jsmith@example.com",
"name": "<string>"
},
"occurredAt": "2023-11-07T05:31:56Z"
}
],
"auditFeedTruncated": true,
"readiness": {
"ready": true,
"gates": [
{
"gate": "registration",
"status": "ready",
"reason": "<string>"
}
]
},
"authority": {
"advertiserAccountIds": [
"<unknown>"
],
"permissions": [
"<unknown>"
]
},
"notifications": {
"catalog": [
{
"eventType": "scheduled",
"anchor": "caller",
"availability": "available",
"provenance": "@adcp/sdk@14.0.0-rc.33",
"repairTask": "get_principal",
"blockedReason": "event_producer_not_registered"
}
],
"subscriptions": [
{
"subscriberId": "<string>",
"endpointUrl": "<string>",
"eventTypes": [
"scheduled"
],
"desiredActive": true,
"allAuthorizedAccounts": true,
"includeFutureEventTypes": true,
"proofState": "pending",
"verifiedAt": "2023-11-07T05:31:56Z",
"failureCode": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"deliveryHealth": {
"activeSubscriptions": 4503599627370495,
"provenActiveSubscriptions": 4503599627370495,
"pendingOrFailedActiveSubscriptions": 4503599627370495,
"lastProofAt": "2023-11-07T05:31:56Z",
"receipts": [
"<unknown>"
],
"receiptsReason": "no_delivery_receipts_available"
}
},
"access": {
"accessRevision": 4503599627370495,
"advertisers": [
{
"advertiserId": "<string>",
"name": "<string>",
"role": "READ"
}
]
}
},
"error": null
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Buyer Agent Principals
Inspect buyer-agent configuration and readiness
Return the official SDK-backed principal readback together with secret-free notification proof, reporting-destination generations, seller-driven principal.changed transitions, exact-human administration audit records, and five independent readiness gates. A directly authenticated WorkOS organization administrator is required. Proof success, capability, identity, credentials, and business authority are never inferred from one another.
GET
/
buyer-agent-principals
/
{principalId}
/
administration
Inspect buyer-agent configuration and readiness
curl --request GET \
--url https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/administration \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/administration"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/buyer-agent-principals/{principalId}/administration', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"principal": {
"principalId": "<string>",
"displayName": "<string>",
"lifecycleState": "active",
"activeCredentialCount": 4503599627370495
},
"readback": {
"kind": "current",
"principal_id": "<string>",
"principal_kind": "buyer_agent",
"configuration_version": "<string>",
"configuration": {
"notification_configs": [
{
"subscriber_id": "<string>",
"url": "<string>",
"event_types": [
"scheduled"
],
"all_authorized_accounts": true,
"include_future_event_types": true,
"authentication": {
"schemes": [
"Bearer"
]
},
"active": true,
"ext": {}
}
],
"reporting_destinations": [
{
"destination_id": "<string>",
"destination_ref": "<string>",
"state": "validating",
"configuration": {
"pattern": "file_transfer",
"destination_id": "<string>",
"active": true,
"provider": {
"domain": "<string>"
},
"transport": "<string>",
"location": "<string>",
"accepted_formats": [
"jsonl"
],
"accepted_verification_profiles": [
"native_commit"
],
"operator_id": "<string>"
},
"prior_destination_refs": [
"<string>"
],
"setup": {
"action": "grant_access",
"setup_url": "<string>",
"expires_at": "<string>"
},
"issues": [
{
"code": "<string>",
"message": "<string>",
"buyer_reason": {
"code": "<string>",
"message": "<string>"
},
"field": "<string>",
"suggestion": "<string>",
"retry_after": 1800.5,
"issues": [
{
"pointer": "<string>",
"message": "<string>",
"keyword": "<string>",
"schemaPath": "<string>",
"schema_id": "<string>",
"discriminator": [
{
"property_name": "<string>",
"value": "<string>"
}
]
}
],
"details": {},
"recovery": "transient",
"source": "producer",
"sdk_id": "<string>"
}
]
}
],
"declarations": {
"declared": {
"async_adcp_versions": [
"<string>"
],
"webhook_signing_algorithms": [
"ed25519"
],
"experimental_features": [
"<string>"
]
},
"accepted": {
"async_adcp_versions": [
"<string>"
],
"webhook_signing_algorithms": [
"ed25519"
],
"experimental_features": [
"<string>"
]
},
"selected_async_adcp_version": "<string>",
"exclusions": [
{
"axis": "async_adcp_versions",
"value": "<string>",
"reason": "<string>"
}
]
},
"retired_destinations": [
{
"destination_id": "<string>",
"destination_refs": [
"<string>"
],
"revoked_at": "<string>"
}
]
}
},
"proof": {
"notificationEndpoints": [
{
"subscriberId": "<string>",
"desiredActive": true,
"proofState": "pending",
"verifiedAt": "2023-11-07T05:31:56Z",
"failureCode": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"reportingDestinations": [
{
"destinationId": "<string>",
"destinationRef": "<string>",
"generation": 4503599627370495,
"pattern": "file_transfer",
"desiredActive": true,
"setupState": "validating",
"proofState": "not_attempted",
"lifecycle": "current",
"revokedAt": "2023-11-07T05:31:56Z"
}
],
"reportingDestinationsTruncated": true
},
"stateFeed": [
{
"transitionId": "<string>",
"event": "principal.changed",
"scope": "principal",
"reason": "principal_suspended",
"repairTask": "get_principal",
"occurredAt": "2023-11-07T05:31:56Z"
}
],
"stateFeedTruncated": true,
"auditFeed": [
{
"auditId": "<string>",
"control": "deactivate_destination",
"targetId": "<string>",
"actor": {
"userId": "<string>",
"email": "jsmith@example.com",
"name": "<string>"
},
"occurredAt": "2023-11-07T05:31:56Z"
}
],
"auditFeedTruncated": true,
"readiness": {
"ready": true,
"gates": [
{
"gate": "registration",
"status": "ready",
"reason": "<string>"
}
]
},
"authority": {
"advertiserAccountIds": [
"<unknown>"
],
"permissions": [
"<unknown>"
]
},
"notifications": {
"catalog": [
{
"eventType": "scheduled",
"anchor": "caller",
"availability": "available",
"provenance": "@adcp/sdk@14.0.0-rc.33",
"repairTask": "get_principal",
"blockedReason": "event_producer_not_registered"
}
],
"subscriptions": [
{
"subscriberId": "<string>",
"endpointUrl": "<string>",
"eventTypes": [
"scheduled"
],
"desiredActive": true,
"allAuthorizedAccounts": true,
"includeFutureEventTypes": true,
"proofState": "pending",
"verifiedAt": "2023-11-07T05:31:56Z",
"failureCode": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"deliveryHealth": {
"activeSubscriptions": 4503599627370495,
"provenActiveSubscriptions": 4503599627370495,
"pendingOrFailedActiveSubscriptions": 4503599627370495,
"lastProofAt": "2023-11-07T05:31:56Z",
"receipts": [
"<unknown>"
],
"receiptsReason": "no_delivery_receipts_available"
}
},
"access": {
"accessRevision": 4503599627370495,
"advertisers": [
{
"advertiserId": "<string>",
"name": "<string>",
"role": "READ"
}
]
}
},
"error": null
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Pattern:
^prin_[A-Za-z0-9_-]{32}$Query Parameters
Required range:
0 < x <= 9007199254740991