Skip to main content
POST
/
v1
/
products
/
check
Soft check: per-furnisher field coverage for a product and profile
curl --request POST \
  --url https://api.example.com/v1/products/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "furnishing_entity_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "consent_id": "<string>",
  "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entities": [
    {
      "furnishing_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "complete": true,
      "models": [
        {
          "model_name": "<string>",
          "met_count": 123,
          "total_count": 123,
          "fields": [
            {
              "field_name": "<string>",
              "met": true
            }
          ]
        }
      ],
      "furnishing_entity_name": "<string>",
      "network_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "consumer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
network_ids
string<uuid>[]
required

Networks to query across; the single policy is applied to all of them.

Minimum array length: 1
product_id
string<uuid>
required

Product to coverage-check.

policy_id
string<uuid> | null

Querying policy applied across every network in network_ids. If omitted, each network's default policy is used.

furnishing_entity_ids
string<uuid>[] | null

Optional furnishing-entity scope. When omitted or empty, data from all furnishers is considered.

Consent token — system resolves identity.

consumer_id
string<uuid> | null

Consumer profile primary key (Consumer.id).

business_id
string<uuid> | null

Business profile primary key (Business.id).

Response

Successful Response

product_id
string<uuid>
required
entities
CoverageCheckEntityOutput · object[]
required
consumer_id
string<uuid> | null
business_id
string<uuid> | null