API Reference
  1. Viv Public API
  2. Clients

Create client document metadata

post
https://{apiHost}/api/v2/public/clients//documents

Create a new document metadata record for a client.

NOTE: This endpoint creates document metadata only (name, type, status, dates).
It does NOT accept file uploads.

About type: the value must match one of Viv's standard client
document types (case-sensitive). Submitting an unrecognized value
returns 400 INVALID_DOCUMENT_TYPE and the response includes the full
list of valid types in details.validTypes for self-correction.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique client identifier

Body Params
string
required

Document name

string
required

Document type label. Must match one of the standard Viv
client document types exactly (case-sensitive). On
invalid values the API responds with 400
INVALID_DOCUMENT_TYPE and lists the valid types in
details.validTypes.

string

Document description

string

Document status

string
^\d{2}/\d{2}/\d{4}$

Document expiry date (MM/DD/YYYY format)

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?