Workspace

Download a KYC document

GEThttps://voxa.abhinavyadav.in/api/v1/kyc/documents/{doc_id}

Authorization

A signed-in member with the kyc.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearerkyc.manageworks before activation

Path parameters

doc_idstringrequired

The document's id.

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

The file itself (application/pdf).

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request GET \
  --url 'https://voxa.abhinavyadav.in/api/v1/kyc/documents/{doc_id}?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --output response.pdf

import requests

url = "https://voxa.abhinavyadav.in/api/v1/kyc/documents/{doc_id}"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.get(url, params=params, headers=headers)
response.raise_for_status()
with open("response.pdf", "wb") as f:
    f.write(response.content)

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/kyc/documents/{doc_id}?timezone=Asia/Kolkata", {
  headers: {
    "Authorization": "Bearer <token>",
  },
})
const file = await response.blob()

Response

A file (application/pdf).

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (kyc.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}