API Reference

Get Request Generic function

get
https://api.liveconsent.com/LCSWS/getrequest

Generic function for Get Request operations.
API function usage type: Standard

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

This is the genereric endpoint for the folowing functions:
Get Request Status
Get Request Recipient Status
Get Request Recipients Status
Get Requests List
Get Request Details
Get Request Messages
Get Recipient Actions
Get Request URLs function

Headers
string
required
Defaults to your developer_key

web service developer key

string
required
Defaults to your authorization_token

token from authentication

string
enum
required

type of query

string

unique id of the request or unique id associated by requester

string
enum

(optional): Values: {request_id, unique_submit_id} - unique id of the request or unique id associated by requester; Default: request_id

Allowed:
string

email of recipient

string

the unique recipient reference for the current request

string
enum

Download transmission type of zip archive

Allowed:
string
enum

Algorithm for computing archive_checksum value in the response

Allowed:
string
enum

Status of LCS requests asked for

Allowed:
string

String matching request_custom field

string
enum

Type of data queried

Allowed:
string

Value for type of data queried

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

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

Updated over 2 years ago