Available Resources

This section contains documentation for all available resources in the AllID Biometrics API. Each resource describes its endpoints, and usage examples.

Biometric Validation

Validates a biometric asset against existing profiles using facial recognition. Returns consensus result, distance, probability, and validation data.

Biometric Validation

post

http://localhost:80https://api.allid.example.com

/profiles/biometric-validation

Validates a biometric asset against existing profiles using facial recognition. Returns consensus result, distance scores, and validation data.

Body

application/json

thresholdLevelstring · enumOptional

Threshold level for validation

Default: HIGHExample: HIGHPossible values:

Responses

200

Successful validation

application/json

messagestring · nullableOptional

Human-readable message

Example: SUCCESS

consensusstring · enumOptional

Consensus result

Example: MATCHPossible values:

isIdempotentbooleanOptional

Indicates if this request was previously processed

Example: false

400

Bad request - Invalid parameters

application/json

422

Unprocessable entity - Missing required parameters

application/json

500

Internal server error

application/json

post/profiles/biometric-validation

HTTPcURLJavaScriptPython

POST /profiles/biometric-validation HTTP/1.1
Host: localhost:80
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "identifier": {
    "data": "12345678900",
    "type": "CPF"
  },
  "biometricAsset": {
    "type": "SELFIE",
    "dataAddress": "https://example.com/image.jpg",
    "name": "user_selfie_001"
  },
  "thresholdLevel": "HIGH",
  "metadata": {
    "source": "mobile_app",
    "sessionId": "abc123"
  }
}

Request with image URLRequest with base64 image

{
  "requestStatus": {
    "status": "SUCCESS",
    "token": "550e8400-e29b-41d4-a716-446655440000"
  },
  "identifier": {
    "data": "12345678900",
    "type": "CPF"
  },
  "consensus": "MATCH",
  "isIdempotent": false,
  "data": {
    "distance": 0.85,
    "probability": 0.92,
    "probabilityStatus": "PHIGH",
    "status": {
      "code": "OK",
      "message": "OK"
    }
  },
  "queries": [
    {
      "consensus": "MATCH",
      "distance": 0.85,
      "profileGuid": "550e8400-e29b-41d4-a716-446655440001",
      "participation": "REQUESTER",
      "peerKey": "peer-001",
      "requestStatus": {
        "status": "SUCCESS",
        "token": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  ]
}

Profile Creation

Creates a new profile with an identifier and biometric asset. The profile can be used for future biometric validations.

Create Profile

post

http://localhost:80https://api.allid.example.com

/profiles

Creates a new profile with an identifier and biometric asset. The profile can be used for future biometric validations.

Body

application/json

Responses

200

Profile created successfully

application/json

messagestring · nullableOptional

Human-readable message

Example: SUCCESS

400

Bad request - Invalid parameters

application/json

422

Unprocessable entity - Missing required parameters

application/json

500

Internal server error

application/json

post/profiles

HTTPcURLJavaScriptPython

POST /profiles HTTP/1.1
Host: localhost:80
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "identifier": {
    "data": "12345678900",
    "type": "CPF"
  },
  "biometricAsset": {
    "type": "SELFIE",
    "dataAddress": "https://example.com/image.jpg",
    "name": "user_selfie_001"
  },
  "metadata": {
    "source": "mobile_app",
    "userId": "user123"
  }
}

Create profile with image URLCreate profile with base64 image

{
  "requestStatus": {
    "status": "SUCCESS",
    "token": "550e8400-e29b-41d4-a716-446655440000"
  },
  "message": "SUCCESS"
}

Next steps

• Review Technical Requirements for deployment specifications
• Review Configuration for environment setup
• Review Production Guidance for deployment instructions