Read a business case

GET/v1/kyb/cases/{id}

Refreshes the persons' verification states first. A decided case carries signed_result, an ES256 JWS (typ kyb_case) with identifiers and outcome only. Needs kyb:read.

Send your API key in the x-api-key header.

Path parameters

idstringuuidrequired

Responses

200The case.
- idstringuuid
- objectstringalways "kyb_case"
- statusany
  One ofopenreview_requiredapproveddeclined
- reasonsarray of object
  Show 2 child propertiesHide child properties
  codestring
  actionany
  One ofreviewdecline
- outstandingarray of any
  What an open case waits for.
- companyobject | null
  Register data: uid, name, legalForm, seat, canton, address, status, purpose, capital, publications.
- uboobject | null
  status identified | partial | none_identified | not_public, threshold_pct, declaration_required.
- signing_rulesarray of object
- personsarray of object
  Registered and declared persons with roles, signing_mode, is_signatory, is_ubo, ownership_pct, verification (status, verification_id) and screening.
- company_screeningobject | null
- declarationobject | null
- documentsarray of object
- declaration_urlstring | null
- signed_resultstring
  Decided cases only, when result signing is configured.
401Missing, unknown or expired API key.
403The key lacks the kyb:read scope.
404No such case in your organization.

curl https://api-verify.secuveri.com/v1/kyb/cases/6f1c2e0a-8f43-4f7e-9a51-2b7c1d9e4a10 \
  -H "x-api-key: $SECUVERI_API_KEY"

Response · 200

{
  "id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
  "object": "kyb_case",
  "status": "open",
  "reasons": [
    {
      "code": "invalid_request",
      "action": "review"
    }
  ],
  "outstanding": [
    "KYB_DECLARATION_MISSING"
  ],
  "company": null,
  "ubo": null,
  "signing_rules": [
    {}
  ],
  "persons": [
    {}
  ],
  "company_screening": null,
  "declaration": null,
  "documents": [
    {}
  ],
  "declaration_url": "<declaration url>",
  "signed_result": "eyJhbGciOiJFUzI1NiIsImtpZCI6Ii4uLiJ9.…"
}