v2

latestSwagger 2.02026-08-0610101.9 MB

Legal persons

Update legal person

Updates the legal-person.

put/v0/legal-persons/{legal-person-id}

Path parameters

legal-person-idstring required

Request body

display-namestring required

A human readable label for an entity

Response

legal-person-type'individual' | 'corporation' required

Specifies if the legal person is an individual or a corporation.

latest-risk-rating-urlstring

A contextual link to the risk rating.

display-namestring required

The mutable display name for the Legal-Person

application-status'referred' | 'errored' | 'declined' | 'submitted' | 'accepted'

Status of the current application

legal-person-status'restricted' | 'onboarding-declined' | 'onboarded' | 'verified' | 'onboarding'

Status of the legal person

status-changed-atstring date-time

ISO 8601 formatted date-time.

created-atstring date-time required

ISO 8601 formatted date-time.

legal-namestring

A read-only, human readable label derived from claims

Example response

{
  "latest-decision": {
    "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
    "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
    "decision-user-username": "user@example.com"
  },
  "latest-risk-rating-url": "/v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA",
  "display-name": "Company name"
}