POST/api/v2/crypto-virtual-accounts/verification/business

Start provider-hosted business verification. An authorisation_required status requires the business authorisation code flow.

Supply the company-owned userId query parameter and the company x-api-key. Exchange must be enabled for the company. Verification responses use no-store caching.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
userId (query)	unknown	Yes	Positive Hoppa user ID belonging to the company identified by the API key.

Responses

200 — OK

Response 200 fields
Field	Type	Required
tier	string	Yes
status	string	Yes
verificationUrl	string	Yes

400 — Bad Request

Response 400 fields
Field	Type	Required	Description
message	string	Yes

401 — Unauthorized

Response 401 fields
Field	Type	Required
type	string	No
title	string	No
status	unknown	No
detail	string	No
instance	string	No

403 — Forbidden

Response 403 fields
Field	Type	Required
type	string	No
title	string	No
status	unknown	No
detail	string	No
instance	string	No

404 — Not Found

Response 404 fields
Field	Type	Required	Description
message	string	Yes

409 — Conflict

Response 409 fields
Field	Type	Required	Description
message	string	Yes

502 — Bad Gateway

Response 502 fields
Field	Type	Required	Description
message	string	Yes

Example request

curl -X POST "https://{base_url}/api/v2/crypto-virtual-accounts/verification/business" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.