Add a Document

post

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

Declares an additional document for an existing entity: a proof of address, articles of incorporation, a power of attorney or any other supporting document.

Path Params

entityId

uuid

required

internalId of the entity.

Body Params

type

string

enum

required

See Document and Proof Types.

string

required

Document number, 1 to 30 characters. Unique with type in your merchant. For evidence without an official number, use your own reference (for example POA-0001).

issuingCountry

string

ISO 3166-1 alpha-3.

issueDate

date

YYYY-MM-DD.

expirationDate

date

YYYY-MM-DD.

metadata

object

Free-form metadata.

Headers

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

201Created.

400Bad Request. VALIDATION_ERROR: A field, header, path or query parameter is missing, unknown or invalid. 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.