API reference v0.1.0
Base URL https://api.jaryo.org/v1. Generated from code — machine-readable: openapi.json (OpenAPI 3.1). Auth: Authorization: Bearer <key>. Errors: RFC 9457 application/problem+json with a type under https://jaryo.org/problems/. Every data response includes attribution. See the field dictionary.
Limits — with a key: per day, 30 per minute, 5 in flight at once. Without a key (/v1/status, /v1/sources, /v1/openapi.json): 60 per minute per IP.
GET/v1/verify
Verify a Korean corporation — start here (no key needed) no key
| Parameter | In | Required | Type | Notes |
|---|---|---|---|---|
q | query | yes | string |
Responses: 200, 400, 429
POST/v1/resolve
Find the Jaryo company entity for a name or an official identifier API key
Body (JSON): name, biz_no, corp_reg_no, dart_corp_code, g2b_vendor_id
Responses: 200, 400, 401, 429
GET/v1/companies/{id}
Company profile: names, identifiers, current profile records, record counts API key
| Parameter | In | Required | Type | Notes |
|---|---|---|---|---|
id | path | yes | string | Jaryo entity id (ULID) |
Responses: 200, 400, 401, 404, 429
GET/v1/companies/{id}/records
Public records attached to a company (current versions) API key
| Parameter | In | Required | Type | Notes |
|---|---|---|---|---|
id | path | yes | string | Jaryo entity id (ULID) |
type | query | string: company_profile, vendor_profile, award, contract, filing, employment, status, sanction, corp_outline, corp_code | ||
limit | query | integer | ||
cursor | query | string | ||
as_of | query | string | Point-in-time view — planned for phase 2; rejected with 400 now. |
Responses: 200, 400, 401, 404, 429
GET/v1/search
Search companies by Korean or English name (top 20) API key
| Parameter | In | Required | Type | Notes |
|---|---|---|---|---|
q | query | yes | string | Name or part of it. Case, spaces and legal-form words (주식회사, (주)) are ignored. Queries of 3+ characters match any part of a name; 1-2 characters match names that start with them. |
limit | query | integer |
Responses: 200, 400, 401, 429
GET/v1/sources
Source catalog with license and redistribution status (no key needed) no key
Responses: 200
GET/v1/status
Availability, source freshness and measured resolution accuracy (no key needed) no key
Responses: 200