Skip to main content

Provider Service

Manages identity verification and biometric providers.

Get Provider

GET /v1/providers/{id}

Retrieves details of a specific provider.

Path Parameters:

ParameterTypeDescription
idstringProvider ID

Response:

{
"id": "provider_miniailive",
"name": "MiniAiLive",
"requirements": {
"api_key": {
"label": "API Key",
"description": "Authentication key for the provider API",
"required": true,
"sensitive": true,
"default": null,
"type": "string"
},
"endpoint": {
"label": "API Endpoint",
"description": "Base URL for the provider API",
"required": true,
"sensitive": false,
"default": "https://api.miniailive.com",
"type": "string"
}
},
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z"
}

Provider Config Fields

FieldTypeDescription
labelstringDisplay label
descriptionstringField description
requiredbooleanWhether this field is required
sensitivebooleanWhether this field contains sensitive data
defaultstringDefault value (null if none)
typestringData type

List Providers

GET /v1/providers

Lists all available providers with pagination.

Query Parameters:

ParameterTypeDescription
limitintegerMax results to return
starting_afterstringCursor: return results after this provider ID
ending_beforestringCursor: return results before this provider ID

Response:

{
"data": [
{
"id": "provider_miniailive",
"name": "MiniAiLive",
"requirements": { ... },
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z"
}
],
"has_more": false
}