Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Stipple Sh Companies API
version: 0.6.0
contact:
name: Stipple
url: https://www.stipple.sh/contact
license:
name: Security & terms
url: https://www.stipple.sh/security
description: 'Operations tagged Companies across 2 of this provider''s published API definitions: www.stipple.sh-openapi.json, stipple-sh-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.stipple.sh
description: Production
tags:
- name: Companies
paths:
/v1/companies/resolve:
post:
tags:
- Companies
summary: Resolve Company
description: 'Resolve a company name or identifier to ONE company, or say why it could not.
Costs 2 credits.
`query` takes a name ("Fonterra Australia") or an identifier (ABN, ACN, NZBN). An
identifier resolves DIRECTLY - no name search and no ranking - so an exact number can
never land on a near-miss.
READ `status` BEFORE `candidates`:
- `resolved` exactly one company. `selected` is it.
- `ambiguous` more than one. `selected` is null ON PURPOSE. Several real companies
match and choosing between them is yours to do, with the evidence here.
- `not_found` every register answered, and none of them has it.
- `inconclusive` a register could not be read, so absence proves nothing.
`coverage` lists every source and how well it was read, INCLUDING the ones that were
blocked or unreadable. A source that was not read is never silently dropped, because
that is what would let `not_found` mean "we could not look".
`match_quality` orders candidates and nothing more. It never promotes one to `selected`.'
operationId: resolve_company_v1_companies_resolve_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyResolveBody'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
additionalProperties: true
type: object
title: Response Resolve Company V1 Companies Resolve Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
servers:
- url: https://www.stipple.sh
description: Production
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
CompanyResolveBody:
properties:
query:
type: string
title: Query
jurisdiction:
anyOf:
- type: string
- type: 'null'
title: Jurisdiction
type: object
required:
- query
title: CompanyResolveBody
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
x-refined-from:
- www.stipple.sh-openapi.json
- stipple-sh-openapi.json