Get KYB for a corporate

Returns the KYB status for the logged-in corporate.

Security

auth_token and api-key

curl -i -X GET \
  https://sandbox.weavr.io/multi/corporates/kyb \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Success

Headers

request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json

corporateKybStatusstring(CorporateKybStatusValue)

The Corporate KYB Status for the corporate's regulatory FI. Indicates whether the corporate can use the FI service.

Enum:"NEW""PENDING""APPROVED""REJECTED""CLOSED"

kybRunsArray of objects(KybRun)

The KYB Runs of the corporate, one per verification attempt against a regulatory FI.

kybStatusstring(KyiStatus)deprecated

The effective due diligence status of the logged-in corporate user. Deprecated in favour of corporateKybStatus.

Enum:"NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"

ongoingKybStatusstring(KyiStatus)deprecated

The ongoing due diligence status of the logged-in corporate user. Deprecated in favour of corporateKybStatus.

Enum:"NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"

Response

{
  "kybStatus": "NOT_STARTED",
  "ongoingKybStatus": "NOT_STARTED",
  "corporateKybStatus": "NEW",
  "kybRuns": [
    { … }
  ]
}