Remote

createRemoteVerify

post

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

Body
Responses
200

OK

application/json
post
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
Responses
200

OK

application/json
post
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
Responses
200

OK

application/json
post
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
get
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
approvalbooleanOptional
Responses
200

OK

post
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
guidstringOptional
Responses
200

OK

post
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
userIdstringOptional
operatorIdstringOptional
imagestringOptional
Responses
200

OK

application/json
post
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"
}