Discovery needs no key. Ratings and market analysis are Pro.
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: Parcha Checks API
version: '1.0'
description: 'Operations tagged Checks across 2 of this provider''s published API definitions: parcha-docs-openapi.yaml, parcha-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.parcha.ai/api/v1
description: Agent Hub API server
- url: https://demo.parcha.ai/api/v1
description: Sandbox API server
- url: https://us1.parcha.ai/api/v1
description: Legacy API server
- url: http://{your-company-domain}.parcha.ai/api/v1
description: Custom Enterpris server (your company's API server)
tags:
- name: Checks
paths:
/checks:
get:
security:
- bearerAuth: []
summary: Get available checks with filtering
description: Get available checks with flexible filtering options
parameters:
- name: check_type
in: query
schema:
type: string
enum:
- kyb
- kyc
- entity
description: Optional filter for check type
- name: check_id
in: query
schema:
type: string
description: Optional specific check ID to retrieve
responses:
'200':
description: Checks retrieved successfully
'404':
description: Check not found
'500':
description: Internal server error
tags:
- Checks
operationId: getChecks
x-operation-id-source: derived
servers:
- url: https://api.parcha.ai/api/v1
description: Agent Hub API server
- url: https://demo.parcha.ai/api/v1
description: Sandbox API server
- url: https://us1.parcha.ai/api/v1
description: Legacy API server
- url: http://{your-company-domain}.parcha.ai/api/v1
description: Custom Enterpris server (your company's API server)
/api/v1/checks:
get:
summary: Get Checks
description: 'Get available checks with flexible filtering options
Accessible to all authenticated users - the checks catalog is informational.
Actual permission to add checks to agents is controlled by the agent upsert endpoint.
Args:
check_type: Optional filter for check type (kyb, kyc, entity)
check_id: Optional specific check ID to retrieve
Returns:
- If check_id is provided: Details for that specific check with enriched tool arguments
- If check_type is provided: All checks matching that type
- If neither is provided: All available checks'
operationId: get_checks_api_v1_checks_get
security:
- HTTPBearer: []
parameters:
- name: check_type
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Check Type
- name: check_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Check Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Checks
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: API key obtained from your Parcha account settings. Include as Bearer token in the Authorization header.
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- parcha-docs-openapi.yaml
- parcha-openapi-original.json