Skip to main content
POST
Resolve identifiers to property_rids (and contribute them)

Authorizations

Authorization
string
header
required

Bearer token in the Authorization header. Two token types are accepted:

  • Organization API key (sk_...) issued via the dashboard. Org-scoped, long-lived, for server-to-server use.
  • User JWT obtained via the OAuth 2.1 authorization code flow with PKCE. User-scoped, short-lived. Discover the authorization server at /.well-known/oauth-authorization-server and the protected-resource metadata at /.well-known/oauth-protected-resource/api.

Body

application/json

Up to 10,000 identifiers plus provenance. resolve requires authentication and contributes unknown identifiers; lookup is read-only. Domain/subdomain values must follow core/identifier.json; production rejects reserved test domains. sandbox: true simulates contributions without writes.

identifiers
object[]
required

Identifiers to resolve (and, in resolve mode, contribute). Max 10,000 per call for all callers.

Required array length: 1 - 10000 elements
provenance
object
required
mode
enum<string>
default:resolve

resolve (default) contributes identifiers, creates missing catalog entries, and logs activity; authentication is required. lookup is a public read with no writes or activity logging.

Available options:
resolve,
lookup
sandbox
boolean
default:false

Simulate contributions without storing properties, identifiers, facts, or activity. Reads existing catalog data; new handles are ephemeral. Reserved test domains are allowed only in sandbox mode.

Response

Resolve/lookup result

resolved
object[]
required
summary
object
required
server_timestamp
string
required
sandbox
enum<boolean>

Present for a non-persistent sandbox simulation. New property handles are ephemeral.

Available options:
true