API Reference

Creates a new identity-document collection for an employee.

post
https://example.com/wep/companies//employees//id-collection

Access: System, Admin, and ClientAdmin users only.

Submit the document metadata and up to four page files as multipart form data. Page 1 is required; additional pages are optional.

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

Company identifier from the route.

int32
required

Employee identifier from the route.

Body Params
string

Document code or short label that identifies the uploaded collection.

int32
enum

Identity-document collection type accepted by the employee identity-document endpoints.

Members:

  • 1 - ListA ( Single List A document. )
  • 2 - ListBAndC ( Combined List B and List C document set. )

Allowed:
int32
enum

Numeric enum describing the employee access level assigned to an uploaded document.

Members:

  • 0 - None ( The employee is not granted access to the document. )
  • 1 - Read ( The employee can access the document with read permissions. )
  • 2 - Write ( The employee can access the document with write permissions. )

Allowed:
file

Required first page image for the identity-document collection.

file

Optional second page image for the identity-document collection.

file

Optional third page image for the identity-document collection.

file

Optional fourth page image for the identity-document collection.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated about 1 month ago

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

Updated about 1 month ago