Capture Instance Status

getProfile

get

Retrieves a previously performed profile capture.

Query parameters
tguidstringOptional
Responses
200

OK

application/json
get
/bcc/capture

overwriteCaptureData

post

Overwrites all the biometric data of a capture.

Query parameters
tguidstringOptional
Body
pguidstringOptional
tguidstringOptional
responsiblePguidstringOptional
insertionDatestring · date-timeOptional
transactionDatestring · date-timeOptional
gbdsStatusstring · enumOptionalPossible values:
currentTransactionbooleanOptional
startDatestring · date-timeOptional
stopDatestring · date-time[]Optional
restartDatestring · date-time[]Optional
labelsstring[]Optional
externalIDNamestringOptional
externalIDValuestringOptional
Responses
200

OK

application/json
post
/bcc/capture

addCaptureData

put

Add biometric data to a capture.

Query parameters
tguidstringOptional
Body
pguidstringOptional
tguidstringOptional
responsiblePguidstringOptional
insertionDatestring · date-timeOptional
transactionDatestring · date-timeOptional
gbdsStatusstring · enumOptionalPossible values:
currentTransactionbooleanOptional
startDatestring · date-timeOptional
stopDatestring · date-time[]Optional
restartDatestring · date-time[]Optional
labelsstring[]Optional
externalIDNamestringOptional
externalIDValuestringOptional
Responses
200

OK

application/json
put
/bcc/capture

deleteProfile

delete

Deletes a previously performed capture.

Query parameters
tguidstringOptional
Responses
200

OK

application/json
delete
/bcc/capture

status

get

Returns the current status of any open capture scene.

Query parameters
tguidstringOptional
Responses
200

OK

application/json
get
/bcc/capture/status

listCaptureInstances

get

Lists open capture instances.

Responses
200

OK

application/json
get
/bcc/capture/instances

restartBcc

delete

Restarts BCC Service.

Responses
200

OK

application/json
delete
/bcc/capture/restart

openCapture

get

Opens an existing profile for editing.

Query parameters
tguidstringOptional
Responses
200

OK

application/json
get
/bcc/capture/open

resetCapture

get

Clear all profile data.

Query parameters
tguidstringOptional
Responses
200

OK

application/json
get
/bcc/capture/reset

Last updated

Was this helpful?