---
title: "Check profiles"
method: POST
path: "/api/v1/business/profiles/check"
tags: ["business"]
---

# Check profiles

`POST /api/v1/business/profiles/check`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/profiles/check`
- Auth: OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Review a described business profile before generating it, as the signed-in member: every attached upload must be ready, and the description and the files' names are screened for acceptable use (a denial is POLICY_DENIED with the reason to show). Then one included (unbilled) web search matches the description: `match.reading` is what the words themselves say about the subject (name, entity type, affiliation, role, location, website; null where unsaid) and `match.candidates` the public matches it found, best first, none when it found none. Returns the files generate will read and the match. Call business_profiles_generate with the same description, attachmentIds and Idempotency-Key, and subjectMatch {id, candidateIndex} for the candidate the member confirmed (null for none), to reuse this screen.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required

## Request body

- BusinessProfilesCheckRequest
  - `description` string, required: Who or what the profile is about, in the member's own words, for a subject with no website to start from: a person, practice, product or offering. Research identifies it from these words and any attached files.
  - `attachmentIds` string[]: Ids of ready uploads to attach to the description

## Response `200`

Success.

- BusinessProfilesCheckResponse
  - `attachments` object[], required: The attached files generate will read, as their uploads were admitted
    - `id` string, uuid, required
    - `filename` string, required
    - `mediaType` string, required
    - `byteLength` integer, required
  - `match` object, required
    - `id` string, uuid, required: This match's id: pass it with the chosen candidateIndex as business_profiles_generate's subjectMatch
    - `reading` object, required: What the description's own words say about its subject; null where they say nothing
      - `subject` string, nullable, required
      - `entityType` 'person' | 'business' | 'nonprofit' | 'public_institution' | 'product_or_offering', nullable, required
      - `affiliation` string, nullable, required
      - `role` string, nullable, required
      - `location` string, nullable, required
      - `website` string, nullable, required
    - `candidates` object[], required: Public matches a web search found for the description, best first; empty when it found none
      - `name` string, required
      - `entityType` 'person' | 'business' | 'nonprofit' | 'public_institution' | 'product_or_offering', required
      - `affiliation` string, nullable, required
      - `role` string, nullable, required
      - `location` string, nullable, required
      - `website` string, nullable, required
      - `summary` string, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)