Reveal a document number

Returns the unmasked document number held on one of a user’s files, and records the read in the profile changelog. Every other endpoint returns metadata.documentNumber as null alongside a masked metadata.documentNumberMasked, so this is the only way to obtain the value — and it always leaves an audit entry naming the caller, the file and the time. The audit write is not best-effort: if it fails, the number is not returned.

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

User ID

Body Params
number
required

Id of the file whose document number should be revealed. Must belong to the user named in the path and to the caller’s company.

string
required

Key of the profile field the file is attached to, recorded on the audit entry so it stays readable after the field is renamed or deleted.

Responses

404

No such file for this user in the caller’s company, or the file holds no document number.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json