> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-en/sdks/backend-sdk/iad/technical_documentation/api_reference/management/get-the-current-configuration.md). # Get the current configuration Returns the public configuration of the service, with every value as a string. It includes the service parameters with their default value or the one set in `config.json`, and any other parameter defined in `config.json` or sent to `POST /api/v1/iad/config`. It does not reflect values set through environment variables, and it never exposes the JWT authentication settings. ```json {"openapi":"3.0.1","info":{"title":"IAD Service REST API","version":"3.0.0"},"tags":[{"name":"Management","description":"Service management and monitoring endpoints"}],"servers":[{"url":"http://127.0.0.1:6982/"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT signed with HS256 and sent as `Authorization: Bearer `. Only required when JWT authentication is enabled."},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"The same JWT sent in the API key header. `x-api-key` is the default header name; it can be overridden at startup with `auth_api_key_header_name`. Only required when JWT authentication is enabled."}},"schemas":{"ConfigData":{"type":"object","description":"Public view of the runtime configuration returned by `GET /api/v1/iad/config`. Every value is returned as a string. It contains the service parameters (`port`, `number_of_threads`, `connection_timeout`, `keep_alive_request_number`, `client_max_body_size`, `logger_path`, `logger_level`, `logger_rotation` and `logger_max_files`) with their default value or the one set in `config.json`, and any other parameter defined in `config.json` or sent to `POST /api/v1/iad/config`. It does not reflect values set through environment variables. JWT authentication settings are intentionally omitted. The response may contain additional keys; ignore the ones you do not recognize.\n","additionalProperties":{"type":"string"},"properties":{"port":{"type":"string"},"number_of_threads":{"type":"string"},"connection_timeout":{"type":"string"},"keep_alive_request_number":{"type":"string"},"client_max_body_size":{"type":"string"},"logger_path":{"type":"string"},"logger_level":{"type":"string"},"logger_rotation":{"type":"string"},"logger_max_files":{"type":"string"},"engine_url":{"type":"string","description":"Base URL of the capture analysis runtime. Only present when it is defined in `config.json`."},"metrics_error_rate_warning":{"type":"string","description":"Example of a `metrics_*` threshold. Only present when it is defined in `config.json` or has been sent to `POST /api/v1/iad/config`."}}},"BadRequestResult":{"type":"object","description":"The request is not valid, the capture could not be processed, or the license of the service is not valid.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string","description":"Service error message or error normalized by Facephi.","oneOf":[{"$ref":"#/components/schemas/FacephiErrorMessage"},{"type":"string"}]},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"FacephiErrorMessage":{"type":"string","description":"Documented public error messages returned in HTTP 400 responses.\n\n- Capture that the analysis engine could not evaluate (the three capture endpoints): `NoneBecause*` values.\n- Capture rejected by the experimental replay mitigation (the three capture endpoints): `Replay attack detected`.\n- Unclassified failure of the analysis engine: `ErrorProcessing` (`POST /api/v1/iad/evaluate` and `POST /api/v1/iad/evaluate/custom`) or `ErrorFacialImage` (`POST /api/v1/iad/extract`).\n- License that stopped being valid while the service runs (the three capture endpoints): `Invalid license: (code:

)`. The capture is not analyzed.\n- Request validation on the three capture endpoints: `Empty multipart payload`, `Required multipart field 'capture' not found` and `Empty data in multipart field 'capture'`.\n- Request validation specific to `POST /api/v1/iad/evaluate/custom`: the `pipeline` and `calibration` messages.\n- Service not ready: `Service not initialized` and `Service not configured`.\n\nWhen the analysis engine does not respond, the capture endpoints answer HTTP 503 with `Engine communication error:` followed by the detail (see `ServiceUnavailableResult`). `GET /api/v1/iad/health` answers HTTP 503 when the service cannot handle evaluations.\n","enum":["NoneBecauseFaceTooClose","NoneBecauseFaceNotFound","NoneBecauseFaceTooSmall","NoneBecauseAngleTooLarge","NoneBecauseImageDataError","NoneBecauseLicenseError","NoneBecauseTooManyFaces","NoneBecauseFaceTooCloseToBorder","NoneBecauseFaceCropped","NoneBecauseFaceOccluded","NoneBecauseEyesClosed","Replay attack detected","ErrorProcessing","ErrorFacialImage","Empty multipart payload","Required multipart field 'capture' not found","Empty data in multipart field 'capture'","Required multipart field 'pipeline' not found","Invalid value for 'pipeline'; expected 'iad_r01' or 'iad_r00'","Invalid value for 'calibration'; expected 'regular' or 'hardened'","Service not initialized","Service not configured"]},"TimeStamp":{"type":"string","description":"UTC date and time in `%Y-%m-%dT%H:%M:%SZ` format (second precision)."},"UnauthorizedResult":{"type":"object","description":"The authentication token is missing or invalid.","properties":{"status":{"type":"number"},"error":{"type":"string"},"message":{"type":"string","description":"Reason for the rejection (`Missing authentication token`, `Authentication secret is not configured`, `JWT token is expired`, `JWT token is not yet valid`, `JWT token does not include exp claim` or `JWT token validation failed`). Use the HTTP status code, not the text, to make decisions."},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}}},"responses":{"Unauthorized":{"description":"The authentication token is missing or invalid. Only returned when JWT authentication is enabled. The response includes the `WWW-Authenticate` header with the value `Bearer`.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResult"}}}}}},"paths":{"/api/v1/iad/config":{"get":{"summary":"Get the current configuration","description":"Returns the public configuration of the service, with every value as a string. It includes the service parameters with their default value or the one set in `config.json`, and any other parameter defined in `config.json` or sent to `POST /api/v1/iad/config`. It does not reflect values set through environment variables, and it never exposes the JWT authentication settings.","operationId":"getConfig","tags":["Management"],"responses":{"200":{"description":"Current configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigData"}}}},"400":{"description":"The service is not initialized (`Service not initialized`), or the configuration could not be serialized to JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResult"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```