Skip to main content
POST
/
v1
/
admin
/
relationships
/
people
/
{id}
/
documents
Create person document
curl --request POST \
  --url https://{operatorDomain}/v1/admin/relationships/people/{id}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "passport",
  "issuingCountry": "<string>",
  "expiresOn": "2023-12-25",
  "isPrimary": true
}
'
{
  "id": "pdoc_01h...",
  "personId": "<string>",
  "kind": "passport",
  "issuingCountry": "<string>",
  "isPrimary": true,
  "numberLast4": "<string>",
  "expiresOn": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Path Parameters

​
id
string
required

Body

application/json
​
kind
string
required
Example:

"passport"

​
issuingCountry
string | null
​
expiresOn
string<date> | null
​
isPrimary
boolean

Response

201 - application/json

Created document

​
id
string
required
Example:

"pdoc_01h..."

​
personId
string
required
​
kind
string
required
Example:

"passport"

​
issuingCountry
string | null
​
isPrimary
boolean
​
numberLast4
string | null
​
expiresOn
string<date> | null