> ## Documentation Index > Fetch the complete documentation index at: https://unif.dev/llms.txt > Use this file to discover all available pages before exploring further. # Resolve identifiers to entities > Turns the identifiers you already have — a storefront URL, an `@handle`, a product link, a channel-native ID — into stable Unif IDs. Resolution is the step that lets you join Unif data onto rows you already own. Send up to 100 inputs per request. Each input resolves independently; a failure on one does not fail the request. ## OpenAPI ````yaml /api-reference/openapi.yaml post /resolve openapi: 3.1.0 info: title: Unif API version: '2026-09-01' summary: One schema for commerce data across every channel. description: > The Unif API returns normalized commerce data — shops, products, creators, videos, livestreams and categories — through a single schema that does not change when the underlying data source does. Each request runs a cascade across the sources behind a channel, in cost order, stopping at the first result that verifies. You are charged for the hit, not for the attempts. See [the waterfall](/docs/concepts/waterfall). Every response is denominated in the currency you ask for, scoped to a market, and measured over a period you control, whichever source answered. **Base URL** ``` https://api.unif.dev/v1 ``` All requests require a bearer token. See [Authentication](/docs/authentication). **Conventions** - Success and failure are carried by the HTTP status code. There is no envelope to unwrap: a `200` body is the object itself, and any `4xx` or `5xx` body is an [error object](/docs/platform/errors). - Lists are cursor-paginated. Read `next_cursor` and stop when `has_more` is false. - Every response carries `X-Request-Id`. Billable responses also carry `X-Unif-Credits-Charged` and `X-Unif-Credits-Remaining`. - Monetary fields are converted to the `currency` you request, and every object repeats the `currency` and `period` it was measured under. contact: name: Unif Support email: support@unif.dev url: https://unif.dev/docs license: name: Proprietary url: https://unif.dev/legal/terms servers: - url: https://api.unif.dev/v1 description: Production security: - bearerAuth: [] tags: - name: Meta description: Workspace, channel availability and field coverage. - name: Shops description: Storefronts and sellers. - name: Products description: Listings, pricing and sales performance. - name: Creators description: Affiliates and influencers who sell. - name: Videos description: Short-form video attributed to sales. - name: Livestreams description: Live selling sessions. - name: Categories description: The normalized category tree and category-level market data. - name: Resolution description: Turn a URL, handle or external ID into a Unif entity. - name: Jobs description: Asynchronous work for large searches, enrichments and exports. - name: Lists description: Saved sets of entities. - name: Trackers description: Scheduled re-checks that emit webhook events on change. - name: Webhooks description: Endpoint registration and delivery settings. - name: Usage description: Credit balance and per-request consumption. paths: /resolve: post: tags: - Resolution summary: Resolve identifiers to entities description: > Turns the identifiers you already have — a storefront URL, an `@handle`, a product link, a channel-native ID — into stable Unif IDs. Resolution is the step that lets you join Unif data onto rows you already own. Send up to 100 inputs per request. Each input resolves independently; a failure on one does not fail the request. operationId: resolveEntities requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResolveRequest' examples: mixedIdentifiers: summary: A URL, a handle and a native ID value: inputs: - type: shop url: https://www.tiktok.com/shop/glowlab - type: creator handle: '@glowbyjune' market: US - type: product channel: tiktok_shop external_id: '1729384756102938' responses: '200': description: Resolution results, in the order the inputs were sent. content: application/json: schema: $ref: '#/components/schemas/ResolveResponse' '400': $ref: '#/components/responses/BadRequest' '429': $ref: '#/components/responses/RateLimited' components: schemas: ResolveRequest: type: object required: - inputs properties: inputs: type: array minItems: 1 maxItems: 100 items: $ref: '#/components/schemas/ResolveInput' ResolveResponse: type: object properties: object: type: string const: resolve_response data: type: array items: $ref: '#/components/schemas/ResolveResult' credits_charged: type: integer ResolveInput: type: object description: > One identifier to resolve. Supply exactly one of `url`, `handle` or `external_id`. `handle` and `external_id` need `market` and `channel` respectively to be unambiguous. required: - type properties: type: $ref: '#/components/schemas/EntityType' url: type: string format: uri description: A channel URL for the entity. handle: type: string description: The channel handle with or without a leading `@`.: null external_id: type: string description: The entity's native ID on the channel. channel: $ref: '#/components/schemas/Channel' market: $ref: '#/components/schemas/Market' ref: type: string description: Your own identifier echoed back on the result so you can join rows.: null ResolveResult: type: object properties: ref: type: - string - 'null' status: type: string enum: - resolved - not_found - ambiguous - unsupported description: > `ambiguous` means the identifier matched more than one entity; `candidates` lists them. `unsupported` means the channel or entity type is not enabled for your workspace. id: type: - string - 'null' description: The Unif ID when `status` is `resolved`.: null type: $ref: '#/components/schemas/EntityType' channel: $ref: '#/components/schemas/Channel' market: $ref: '#/components/schemas/Market' candidates: type: array description: Possible matches, when `status` is `ambiguous`. items: type: object properties: id: type: string name: type: string url: type: string format: uri ErrorResponse: type: object required: - error properties: error: $ref: '#/components/schemas/Error' EntityType: type: string enum: - shop - product - creator - video - livestream - category Channel: type: string description: > A sales channel — the commerce surface a request is about. Behind each channel is a cascade of data sources, tried in cost order until one verifies; the roster is published, but which source answered a given row is not carried in the response, so the cascade can be re-tuned without breaking your code. enum: - tiktok_shop examples: - tiktok_shop Market: type: string description: An ISO 3166-1 alpha-2 country code identifying a channel storefront. enum: - US - GB - IE - ES - FR - DE - IT - ID - TH - VN - MY - PH - SG - JP - BR - MX examples: - US Error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - not_found_error - rate_limit_error - billing_error - coverage_error - api_error code: type: string examples: - parameter_invalid message: type: string param: type: - string - 'null' description: The offending field as a dot-path.: null doc_url: type: string format: uri request_id: type: string responses: BadRequest: description: The request was malformed or a parameter was invalid. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: invalid_request_error code: parameter_invalid message: filters.revenue.gte must be a non-negative number. param: filters.revenue.gte doc_url: https://unif.dev/docs/platform/errors#parameter_invalid request_id: req_01k3m9x7v2q8r4t6y0b1n5d7fa RateLimited: description: Too many requests. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: RequestId: description: Unique ID for this request. Include it in support conversations. schema: type: string RetryAfter: description: Seconds to wait before retrying. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RateLimitReset: description: Unix timestamp when the window resets. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer description: > Send your workspace API key as a bearer token: ``` Authorization: Bearer unif_sk_live_... ``` Keys are scoped to a single workspace. See [Authentication](/docs/authentication). ````