API reference

Coverage

Coverage profiles, KYB country releases and country capabilities.

List coverage profiles

GET/v1/coverage

Scopes
coverage:read

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200CoverageList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get a coverage profile

GET/v1/coverage/{coverage_id}

Scopes
coverage:read

Parameters

FieldTypeRequired
coverage_idpathstringyes

Responses

  • 200Coverage
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

List KYB country releases

GET/v1/kyb/country-releases

Scopes
kyb:read

KYB country releases of the environment of the caller: conditions and blockers of each release artifact; a live release requires owner approval.

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200KybCountryReleaseList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

List country capabilities

GET/v1/country-capabilities

Scopes
coverage:read

Capabilities of the countries and purposes of the published policies of the tenant with the effective legal profile of each policy; country filters one country (a country outside the policies is evaluated without the legal profile of the customer).

Parameters

FieldTypeRequired
countryquerystringno
purposequerystringno

Responses

  • 200CountryCapabilityList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503