Remote

createRemoteVerify

post

This method creates a remote capture request for Face and/or Fingerprints verification.

Body

application/json

Responses

200

OK

application/json

tguidstringOptional

dynamicLinkstringOptional

201

Created

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/remote-capture/verify

HTTPcURLJavaScriptPython

POST /gbs-spid-server/remote-capture/verify HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "data": {
    "clientID": "text",
    "operatorID": "text",
    "clientEmail": "text"
  }
}

{
  "tguid": "text",
  "dynamicLink": "text"
}

createRemoteEnroll

post

This method creates a remote capture request for Face and/or Fingerprints enrollment.

Body

application/json

Responses

200

OK

application/json

tguidstringOptional

dynamicLinkstringOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/remote-capture/enroll

HTTPcURLJavaScriptPython

POST /gbs-spid-server/remote-capture/enroll HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "data": {
    "clientID": "text",
    "operatorID": "text",
    "clientEmail": "text"
  }
}

{
  "tguid": "text",
  "dynamicLink": "text"
}

createRemoteVerify

post

Body

application/json

Responses

200

OK

application/json

tguidstringOptional

dynamicLinkstringOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/remote-capture

HTTPcURLJavaScriptPython

POST /gbs-spid-server/remote-capture HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "data": {
    "clientID": "text",
    "operatorID": "text",
    "clientEmail": "text"
  }
}

{
  "tguid": "text",
  "dynamicLink": "text"
}

getBiometrics

get

Path parameters

tguidstringRequired

tguid

Responses

200

OK

application/json

indexinteger · int32Optional

contentstringOptional

widthinteger · int32Optional

heightinteger · int32Optional

resolutioninteger · int32Optional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

get

/gbs-spid-server/remote-capture/biometrics/{tguid}

HTTPcURLJavaScriptPython

GET /gbs-spid-server/remote-capture/biometrics/{tguid} HTTP/1.1
Host: <ip>:8082
Accept: */*

{
  "index": 1,
  "content": "text",
  "width": 1,
  "height": 1,
  "resolution": 1
}

finishRemoteCapture

post

Path parameters

tguidstringRequired

tguid

Body

application/json

approvalbooleanOptional

Responses

200

OK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/remote-capture/finish/{tguid}

HTTPcURLJavaScriptPython

POST /gbs-spid-server/remote-capture/finish/{tguid} HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "approval": true
}

No content

notificationRemoteCapture

post

Body

application/json

guidstringOptional

Responses

200

OK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/remote-capture/notification

HTTPcURLJavaScriptPython

POST /gbs-spid-server/remote-capture/notification HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "guid": "text"
}

No content

faceDetect

post

This method receives a base64 image and detects whether it has a single face or not. If a single face is detected, creates a transaction and returns its TGUID, else returns an error.

Body

application/json

userIdstringOptional

operatorIdstringOptional

imagestringOptional

Responses

200

OK

application/json

idstringOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

415

Unsupported Media Type

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

503

Service Unavailable

*/*

post

/gbs-spid-server/remote-capture/face-detect

HTTPcURLJavaScriptPython

POST /gbs-spid-server/remote-capture/face-detect HTTP/1.1
Host: <ip>:8082
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "userId": "text",
  "operatorId": "text",
  "image": "text"
}

{
  "id": "text"
}