Default

createUserDemand

post

This method returns a dynamic link for sharing attributes already stored in the device using SPIDX.

Body
Responses
200

OK

application/json
post
POST /checkid HTTP/1.1
Host: <ip>:8090
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "data": {
    "securityLevel": "HIGH",
    "biometricFields": [
      "FACE"
    ],
    "otc": 1,
    "notificationEndpoint": "text",
    "organizationName": "text",
    "callback": "text",
    "userEmail": "text",
    "keyIdentifier": {
      "key": "text",
      "value": "text"
    },
    "qualityThreshold": 1
  }
}
{
  "transactionID": {
    "guid": "text"
  },
  "dynamicLink": "text",
  "status": "AWAITING_DATA_COLLECTION"
}

collectUserDataRequest

post

This method returns a dynamic link for real-time capture and sharing of attributes using SPIDX.

Body
Responses
200

OK

*/*
post
POST /checkid/collect HTTP/1.1
Host: <ip>:8090
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "data": {
    "securityLevel": "HIGH",
    "biometricFields": [
      "FACE"
    ],
    "otc": 1,
    "notificationEndpoint": "text",
    "organizationName": "text",
    "callback": "text",
    "userEmail": "text",
    "keyIdentifier": {
      "key": "text",
      "value": "text"
    },
    "qualityThreshold": 1
  }
}
200

OK

{
  "transactionID": {
    "guid": "text"
  },
  "dynamicLink": "text",
  "status": "AWAITING_DATA_COLLECTION"
}

getIdentity

get

This method returns the attributes of a transaction, given its GUID.

Path parameters
guidstringRequired
Responses
200

OK

application/json
get
GET /checkid/{guid} HTTP/1.1
Host: <ip>:8090
Accept: */*

{
  "biometricPackage": {
    "biometricsGuid": "text",
    "biometricList": [
      {
        "content": "text",
        "index": 1,
        "biometricProperties": {
          "width": 1,
          "height": 1,
          "resolution": 1
        }
      }
    ],
    "walletAdress": "text"
  },
  "biographicPackage": {
    "biographicList": [
      {
        "type": "FULL_NAME",
        "value": "text"
      }
    ]
  },
  "userInformation": {
    "spidx": "text",
    "deduplicationStatus": "ENQUEUED",
    "verificationStatus": "MATCH"
  }
}

verifyUserDataRequest

post

This method returns a dynamic link for real-time capture of biometrics to verify user.

Body
Responses
200

OK

*/*
post
POST /checkid/verify HTTP/1.1
Host: <ip>:8090
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "data": {
    "securityLevel": "HIGH",
    "biometricFields": [
      "FACE"
    ],
    "otc": 1,
    "notificationEndpoint": "text",
    "organizationName": "text",
    "callback": "text",
    "userEmail": "text",
    "keyIdentifier": {
      "key": "text",
      "value": "text"
    },
    "qualityThreshold": 1
  }
}
200

OK

{
  "transactionID": {
    "guid": "text"
  },
  "dynamicLink": "text",
  "status": "AWAITING_DATA_COLLECTION"
}