GuidesAPI ReferenceSign-UpRecipes
API Reference

Get captured citizen's details for the given ApplicationId.

get
https://api.consentric.io/citizen-capture

Retrieves previously stored citizens either in JSON format or exported to CSV depending on the Accept header provided.

Please note: Retrieving citizens is a destructive action. Citizens that have been exported will not be included in additional requests unless the includeExported parameter is set to true.

Example table with columns to demonstrate a Citizen represented as CSV:

uniqueReferenceapplicationIddata.firstNamedata.lastNamepartnercreatedAt
jb-mld-05d8BNrPqsgRZJoeBloggspartnerCompanyLtd2019-11-10T16:38:04Z
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The ID associated with the target Application.

boolean

A flag to indicate whether the request should include previously exported values.

Headers
string

The Accept header of the request. Specify "text/csv" for CSV; "application/json" can also be specified but it is the default response type. Errors will be returned in JSON format.

Response

Updated over 1 year ago

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

Updated over 1 year ago