> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quoindata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# resolve_entities



## OpenAPI

````yaml https://portal.quoindata.com/api/v2/openapi.json post /api/v2/resolutions
openapi: 3.1.0
info:
  title: Quoin Property Intelligence API
  version: quoin-v2
  description: Tenant-scoped source-linked property data.
servers:
  - url: https://portal.quoindata.com
security:
  - bearer_auth: []
paths:
  /api/v2/resolutions:
    post:
      summary: resolve_entities
      operationId: resolve_entities
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Unique key for one logical POST. Reuse is replay-safe or returns a
            conflict.
          schema:
            type: string
            minLength: 1
            maxLength: 256
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/resolve_entities'
      responses:
        '200':
          description: Canonical response envelope.
          headers:
            X-Quoin-Balance-Micro-USD:
              description: Remaining welcome credit after the call, in micro-USD.
              schema:
                type: integer
                format: int64
            X-Quoin-Held-Micro-USD:
              description: Outstanding reserved credit after settlement, in micro-USD.
              schema:
                type: integer
                format: int64
                minimum: 0
            X-Quoin-Price-Micro-USD:
              description: Rate snapshot price for the admitted call, in micro-USD.
              schema:
                type: integer
                format: int64
                minimum: 0
            X-Quoin-Rate-Version:
              description: Version of the rate card used for the admitted call.
              schema:
                type: string
            X-Quoin-Calls-30d:
              description: Account call count in the rolling 30-day window.
              schema:
                type: integer
                format: int64
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeV2_resolve_entities'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Error'
      security:
        - bearer_auth: []
components:
  schemas:
    resolve_entities:
      type: object
      properties:
        items:
          minItems: 1
          maxItems: 50
          type: array
          items:
            type: object
            properties:
              client_id:
                type: string
                minLength: 1
                maxLength: 256
              subject_kind:
                type: string
                minLength: 1
                maxLength: 256
              entity_kind:
                type: string
                minLength: 1
                maxLength: 256
              area_uid:
                type: string
                minLength: 1
                maxLength: 128
              identifiers:
                default: []
                maxItems: 50
                type: array
                items:
                  type: object
                  properties:
                    namespace:
                      type: string
                      minLength: 1
                      maxLength: 256
                    raw_value:
                      type: string
                      minLength: 1
                      maxLength: 512
                    normalized_value:
                      type: string
                      maxLength: 512
                  required:
                    - namespace
                    - raw_value
                  additionalProperties: false
              address:
                type: object
                properties:
                  line:
                    type: string
                    minLength: 2
                    maxLength: 160
                  unit:
                    type: string
                    minLength: 1
                    maxLength: 256
                  locality:
                    type: string
                    minLength: 1
                    maxLength: 256
                  region:
                    type: string
                    minLength: 1
                    maxLength: 256
                  postal_code:
                    type: string
                    minLength: 1
                    maxLength: 32
                required:
                  - line
                additionalProperties: false
              include_retired_identifiers:
                default: false
                type: boolean
            required:
              - client_id
              - subject_kind
            additionalProperties: false
        candidate_limit:
          default: 10
          type: integer
          minimum: 1
          maximum: 50
        candidate_cursors:
          description: >-
            Reserved; candidate continuation currently returns unavailable (HTTP
            422).
          type: object
          propertyNames:
            type: string
            minLength: 1
            maxLength: 100
          additionalProperties:
            type: string
            minLength: 1
            maxLength: 4096
      required:
        - items
      additionalProperties: false
    ResponseEnvelopeV2_resolve_entities:
      type: object
      properties:
        contract_version:
          type: string
          const: quoin-v2
        request_id:
          type: string
          minLength: 1
          maxLength: 512
        operation:
          type: string
          minLength: 1
          maxLength: 256
        status:
          type: string
          enum:
            - ok
            - partial
            - error
        data:
          anyOf:
            - type: object
              properties:
                items:
                  maxItems: 50
                  type: array
                  items:
                    type: object
                    properties:
                      client_id:
                        type: string
                        minLength: 1
                        maxLength: 256
                      outcome:
                        type: string
                        enum:
                          - invalid_input
                          - unavailable
                          - retired_only
                          - not_found
                          - ambiguous
                          - resolved
                          - address_found_no_parcel
                      candidates:
                        maxItems: 50
                        type: array
                        items:
                          type: object
                          properties:
                            entity_ref:
                              type: string
                              minLength: 1
                              maxLength: 512
                            entity_kind:
                              type: string
                              enum:
                                - tax_account
                                - parcel
                                - address
                                - building
                                - unit
                                - land_interest
                            status:
                              type: string
                              enum:
                                - current
                                - retired
                                - superseded
                            area_uid:
                              anyOf:
                                - type: string
                                  minLength: 1
                                  maxLength: 128
                                - type: 'null'
                            canonical_identity:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                            property_ref:
                              type: string
                              minLength: 1
                              maxLength: 512
                            match_basis:
                              type: string
                              minLength: 1
                              maxLength: 256
                            precision:
                              anyOf:
                                - type: string
                                  enum:
                                    - exact
                                    - contextual
                                    - ambiguous
                                - type: 'null'
                            method:
                              anyOf:
                                - type: string
                                  minLength: 1
                                  maxLength: 256
                                - type: 'null'
                          required:
                            - entity_ref
                            - entity_kind
                            - status
                            - area_uid
                            - canonical_identity
                            - match_basis
                          additionalProperties: {}
                      address_resolution:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - client_id
                      - outcome
                      - candidates
                    additionalProperties: {}
              required:
                - items
              additionalProperties: {}
            - type: 'null'
        error:
          anyOf:
            - type: object
              properties:
                code:
                  type: string
                  minLength: 1
                  maxLength: 256
                message:
                  type: string
                  minLength: 1
                  maxLength: 4000
                retryable:
                  type: boolean
                retry_after_seconds:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                details: {}
              required:
                - code
                - message
                - retryable
              additionalProperties: false
            - type: 'null'
        meta:
          type: object
          properties:
            served_at:
              type: string
              minLength: 1
              maxLength: 64
            publication_id:
              type: string
              minLength: 1
              maxLength: 256
            generation_ids:
              maxItems: 100
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 256
            truncated:
              type: boolean
            next_cursor:
              type: string
              minLength: 1
              maxLength: 4096
            warnings:
              maxItems: 100
              type: array
              items:
                type: string
                maxLength: 1000
            usage_units:
              type: number
              minimum: 0
          required:
            - served_at
            - truncated
          additionalProperties: false
        provenance:
          anyOf:
            - type: object
              properties:
                source_refs:
                  maxItems: 100
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 512
                sources:
                  maxItems: 100
                  type: array
                  items:
                    type: object
                    properties:
                      source_ref:
                        type: string
                        minLength: 1
                        maxLength: 512
                      source_kind:
                        type: string
                        minLength: 1
                        maxLength: 256
                      publisher:
                        type: string
                        minLength: 1
                        maxLength: 256
                      release_id:
                        type: string
                        minLength: 1
                        maxLength: 256
                      captured_at:
                        type: string
                        minLength: 1
                        maxLength: 64
                      official_url:
                        type: string
                        maxLength: 2048
                        format: uri
                    required:
                      - source_ref
                      - source_kind
                    additionalProperties: false
              required:
                - source_refs
                - sources
              additionalProperties: false
            - type: 'null'
      required:
        - contract_version
        - request_id
        - operation
        - status
        - data
        - error
        - meta
      additionalProperties: false
    ResponseEnvelopeV2:
      type: object
      properties:
        contract_version:
          type: string
          const: quoin-v2
        request_id:
          type: string
          minLength: 1
          maxLength: 512
        operation:
          type: string
          minLength: 1
          maxLength: 256
        status:
          type: string
          enum:
            - ok
            - partial
            - error
        data:
          anyOf:
            - {}
            - type: 'null'
        error:
          anyOf:
            - type: object
              properties:
                code:
                  type: string
                  minLength: 1
                  maxLength: 256
                message:
                  type: string
                  minLength: 1
                  maxLength: 4000
                retryable:
                  type: boolean
                retry_after_seconds:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                details: {}
              required:
                - code
                - message
                - retryable
              additionalProperties: false
            - type: 'null'
        meta:
          type: object
          properties:
            served_at:
              type: string
              minLength: 1
              maxLength: 64
            publication_id:
              type: string
              minLength: 1
              maxLength: 256
            generation_ids:
              maxItems: 100
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 256
            truncated:
              type: boolean
            next_cursor:
              type: string
              minLength: 1
              maxLength: 4096
            warnings:
              maxItems: 100
              type: array
              items:
                type: string
                maxLength: 1000
            usage_units:
              type: number
              minimum: 0
          required:
            - served_at
            - truncated
          additionalProperties: false
        provenance:
          anyOf:
            - type: object
              properties:
                source_refs:
                  maxItems: 100
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 512
                sources:
                  maxItems: 100
                  type: array
                  items:
                    type: object
                    properties:
                      source_ref:
                        type: string
                        minLength: 1
                        maxLength: 512
                      source_kind:
                        type: string
                        minLength: 1
                        maxLength: 256
                      publisher:
                        type: string
                        minLength: 1
                        maxLength: 256
                      release_id:
                        type: string
                        minLength: 1
                        maxLength: 256
                      captured_at:
                        type: string
                        minLength: 1
                        maxLength: 64
                      official_url:
                        type: string
                        maxLength: 2048
                        format: uri
                    required:
                      - source_ref
                      - source_kind
                    additionalProperties: false
              required:
                - source_refs
                - sources
              additionalProperties: false
            - type: 'null'
      required:
        - contract_version
        - request_id
        - operation
        - status
        - data
        - error
        - meta
      additionalProperties: false
  responses:
    Error:
      description: Canonical error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnvelopeV2'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: qk_...
      description: >-
        Send `Authorization: Bearer qk_…` using an API key created in the Quoin
        Developer Portal.

````