Update an Entity

patch

https://api.stage.localpayment.com/api/entity/v1/entities/{entityId}

Partially updates KYC data, address and custom fields.

Path Params

entityId

uuid

required

internalId of the entity.

Body Params

name

string

First name / legal name.

lastname

string

Last name.

occupation

string

Occupation.

residenceCountry

string

ISO 3166-1 alpha-3.

website

string

Website.

legalRepresentativeName

string

Legal representative.

string

Contact email.

phone

object

{ countryCode, areaCode, number }, digits only.

address

object

Full address object (replaces the stored address).

attributes

object

Custom fields; validated against the published schema.

isPep

boolean

Politically exposed person.

Headers

If-Match

string

required

Entity version as returned in the ETag header of your last read. Protects against concurrent updates.

X-Correlation-ID

string

Trace identifier (UUID). Echoed in the response; generated by Localpayment if absent.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK.

400Bad Request. VALIDATION_ERROR: A field, header, path or query parameter is missing, unknown or invalid. details[] lists field and issue. CUSTOM_FIELDS_INVALID: attributes does not satisfy your custom-fields schema. details[] lists field and issue.

401Unauthorized. UNAUTHORIZED: Missing or invalid access token.

404Not Found. ENTITY_NOT_FOUND: The entity does not exist or belongs to another merchant.

409Conflict. ENTITY_NOT_EDITABLE: The entity is REJECTED, BLOCKED or CLOSED, or the operation would remove the primary document or the only document. ENTITY_IN_REVIEW: The entity is IN_REVIEW: its data, documents, files and UBO links are frozen until Localpayment Compliance resolves it.

412Precondition Failed. VERSION_CONFLICT: If-Match does not match the current entity version. Read the entity again and retry.

413Payload Too Large. PAYLOAD_TOO_LARGE: attributes exceeds 64 KB.