{"openapi":"3.1.1","info":{"title":"Kobiat API","version":"1.0.0","description":"Production gateway and isolated synthetic Validator sandbox. Product availability is explicit."},"servers":[{"url":"https://api.kobiat.com/sandbox","description":"Sandbox \u2014 synthetic data only"},{"url":"https://api.kobiat.com","description":"Production \u2014 deliberate selection required"}],"paths":{"/v1/accounts/me":{"get":{"operationId":"accounts_profile_get","summary":"Read your permitted profile","tags":["accounts"],"security":[{"ApiKey":[]},{"OAuth2":["accounts:profile:read"]}],"x-required-scope":"accounts:profile:read","x-availability":"production","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/organisations/{organisation_id}/members":{"get":{"operationId":"accounts_members_get","summary":"List authorised organisation members","tags":["accounts"],"security":[{"ApiKey":[]},{"OAuth2":["accounts:members:read"]}],"x-required-scope":"accounts:members:read","x-availability":"production","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"organisation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/organisations/{organisation_id}/workspaces":{"get":{"operationId":"accounts_workspaces_get","summary":"List authorised workspaces","tags":["accounts"],"security":[{"ApiKey":[]},{"OAuth2":["accounts:workspaces:read"]}],"x-required-scope":"accounts:workspaces:read","x-availability":"production","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"organisation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/validator/jobs":{"post":{"operationId":"validator_create_post","summary":"Create a validation job","tags":["validator"],"security":[{"ApiKey":[]},{"OAuth2":["validator:jobs:create"]}],"x-required-scope":"validator:jobs:create","x-availability":"sandbox","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"},"202":{"description":"Synthetic job accepted","headers":{"Location":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":16,"maxLength":100}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["records"],"properties":{"records":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"},"examples":[["alice@example.invalid","bob@example.invalid"]]},"simulate":{"type":"string","enum":["success","partial","failure"]}}}}}}},"get":{"operationId":"validator_list_get","summary":"Read authorised validation results","tags":["validator"],"security":[{"ApiKey":[]},{"OAuth2":["validator:results:read"]}],"x-required-scope":"validator:results:read","x-availability":"sandbox","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/validator/jobs/{job_id}":{"get":{"operationId":"validator_get_get","summary":"Read authorised validation results","tags":["validator"],"security":[{"ApiKey":[]},{"OAuth2":["validator:results:read"]}],"x-required-scope":"validator:results:read","x-availability":"sandbox","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/validator/jobs/{job_id}/results":{"get":{"operationId":"validator_results_get","summary":"Read authorised validation results","tags":["validator"],"security":[{"ApiKey":[]},{"OAuth2":["validator:results:read"]}],"x-required-scope":"validator:results:read","x-availability":"sandbox","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/validator/jobs/{job_id}/cancel":{"post":{"operationId":"validator_cancel_post","summary":"Create a validation job","tags":["validator"],"security":[{"ApiKey":[]},{"OAuth2":["validator:jobs:create"]}],"x-required-scope":"validator:jobs:create","x-availability":"sandbox","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":16,"maxLength":100}}]}},"/v1/reach/contacts":{"post":{"operationId":"reach_contacts_post","summary":"Import permitted contacts","tags":["reach"],"security":[{"ApiKey":[]},{"OAuth2":["reach:contacts:write"]}],"x-required-scope":"reach:contacts:write","x-availability":"adapter-required","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":16,"maxLength":100}}]}},"/v1/reach/campaigns":{"get":{"operationId":"reach_campaigns_get","summary":"Read permitted campaigns","tags":["reach"],"security":[{"ApiKey":[]},{"OAuth2":["reach:campaigns:read"]}],"x-required-scope":"reach:campaigns:read","x-availability":"adapter-required","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}]}},"/v1/reach/campaigns/{campaign_id}/send":{"post":{"operationId":"reach_send_post","summary":"Submit an authorised campaign","tags":["reach"],"security":[{"ApiKey":[]},{"OAuth2":["reach:campaigns:send"]}],"x-required-scope":"reach:campaigns:send","x-availability":"adapter-required","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"campaign_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":16,"maxLength":100}}]}},"/v1/relay/messages":{"post":{"operationId":"relay_messages_post","summary":"Submit a message","tags":["relay"],"security":[{"ApiKey":[]},{"OAuth2":["relay:messages:send"]}],"x-required-scope":"relay:messages:send","x-availability":"adapter-required","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":16,"maxLength":100}}]}},"/v1/books/reports":{"get":{"operationId":"books_reports_get","summary":"Read authorised financial reports","tags":["books"],"security":[{"ApiKey":[]},{"OAuth2":["books:reports:read"]}],"x-required-scope":"books:reports:read","x-availability":"adapter-required","responses":{"200":{"description":"Successful result"},"401":{"$ref":"#/components/responses/Problem"},"403":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}},"parameters":[{"name":"X-Organisation-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Workspace-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid"}}]}}},"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"Kobiat API key"},"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.kobiat.com/realms/kobiat/protocol/openid-connect/auth","tokenUrl":"https://auth.kobiat.com/realms/kobiat/protocol/openid-connect/token","scopes":{"accounts:profile:read":"Read your permitted profile","accounts:members:read":"List authorised organisation members","accounts:workspaces:read":"List authorised workspaces","reach:contacts:write":"Import permitted contacts","reach:campaigns:read":"Read permitted campaigns","reach:campaigns:send":"Submit an authorised campaign","validator:jobs:create":"Create a validation job","validator:results:read":"Read authorised validation results","relay:messages:send":"Submit a message","books:reports:read":"Read authorised financial reports"}},"clientCredentials":{"tokenUrl":"https://auth.kobiat.com/realms/kobiat/protocol/openid-connect/token","scopes":{"accounts:profile:read":"Read your permitted profile","accounts:members:read":"List authorised organisation members","accounts:workspaces:read":"List authorised workspaces","reach:contacts:write":"Import permitted contacts","reach:campaigns:read":"Read permitted campaigns","reach:campaigns:send":"Submit an authorised campaign","validator:jobs:create":"Create a validation job","validator:results:read":"Read authorised validation results","relay:messages:send":"Submit a message","books:reports:read":"Read authorised financial reports"}}}}},"responses":{"Problem":{"description":"RFC 9457 problem","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}},"schemas":{"Problem":{"type":"object","required":["type","title","status","code","request_id"],"properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"code":{"type":"string"},"request_id":{"type":"string"}}},"Job":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["queued","running","completed","partially_completed","failed","cancelled"]}}}}}}}}