Smile ID

https://docs.usesmileid.com
Admin
Smile ID provides identity verification, biometric authentication, and fraud prevention services...
Tokens:111,817
Snippets:932
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /api-reference/set-up/access.md

Source: https://docs.usesmileid.com/api-reference/set-up/access.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET https://docs.usesmileid.com/api-reference/set-up/access.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/api-reference/set-up/access.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /products/onboarding-with-biometrics/enhanced-document-verification.md

Source: https://docs.usesmileid.com/products/onboarding-with-biometrics/enhanced-document-verification.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /products/onboarding-with-biometrics/enhanced-document-verification.md

### Description
Query the documentation dynamically by asking a question to retrieve relevant excerpts and answers.

### Method
GET

### Endpoint
https://docs.usesmileid.com/products/onboarding-with-biometrics/enhanced-document-verification.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Install via npm

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-components/setup.md

Install the package using npm for use in bundler-based projects.

```sh
npm install @smileid/web-sdk
```

--------------------------------

### GET /products/onboarding-with-biometrics/biometric-kyc.md

Source: https://docs.usesmileid.com/products/onboarding-with-biometrics/biometric-kyc.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /products/onboarding-with-biometrics/biometric-kyc.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.usesmileid.com/products/onboarding-with-biometrics/biometric-kyc.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /guides/migration-guides/smartselfie-tm-authentication-mobile-integration-migration-guide-v10-v11-to-v12.md

Source: https://docs.usesmileid.com/guides/migration-guides/smartselfie-tm-authentication-mobile-integration-migration-guide-v10-v11-to-v12.md

Queries the documentation dynamically by providing a specific question and an optional goal.

```APIDOC
## GET /guides/migration-guides/smartselfie-tm-authentication-mobile-integration-migration-guide-v10-v11-to-v12.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/guides/migration-guides/smartselfie-tm-authentication-mobile-integration-migration-guide-v10-v11-to-v12.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /products/onboarding-businesses.md

Source: https://docs.usesmileid.com/products/onboarding-businesses.md

Queries the documentation page for specific information using natural language questions.

```APIDOC
## GET /products/onboarding-businesses.md

### Description
Perform a query against the documentation content to retrieve answers, excerpts, or sources related to a specific question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/products/onboarding-businesses.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Install React Native dependencies

Source: https://docs.usesmileid.com/developer-resources/sdks/mobile/setup.md

Install the SDK and required peer dependencies using your package manager.

```bash
pnpm add @smileid/usesmileid \
         react-native-quick-crypto react-native-quick-base64 react-native-nitro-modules \
         @smileid/usesmileid_mlkit_face @smileid/usesmileid_mlkit_document \
         @smileid/usesmileid_vision_face @smileid/usesmileid_vision_document
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.usesmileid.com/api-reference/environments.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve dynamic answers.

```http
GET https://docs.usesmileid.com/api-reference/environments.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /guides/migration-guides/biometric-kyc-mobile-integration-migration-guide-v10-v11-to-v12.md

Source: https://docs.usesmileid.com/guides/migration-guides/biometric-kyc-mobile-integration-migration-guide-v10-v11-to-v12.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /guides/migration-guides/biometric-kyc-mobile-integration-migration-guide-v10-v11-to-v12.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/guides/migration-guides/biometric-kyc-mobile-integration-migration-guide-v10-v11-to-v12.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-components/theming-and-customization.md

Perform an HTTP GET request to the documentation URL to ask questions dynamically.

```http
GET https://docs.usesmileid.com/developer-resources/sdks/web/web-components/theming-and-customization.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /api-reference/products/smartselfie-compare.md

Source: https://docs.usesmileid.com/api-reference/products/smartselfie-compare.md

Query the documentation dynamically by performing an HTTP GET request on the documentation page URL.

```APIDOC
## GET /api-reference/products/smartselfie-compare.md

### Description
Query the documentation dynamically by asking a question related to the SmartSelfie Compare product.

### Method
GET

### Endpoint
https://docs.usesmileid.com/api-reference/products/smartselfie-compare.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal you are trying to accomplish.
```

--------------------------------

### GET /products/onboarding-with-biometrics/document-verification.md

Source: https://docs.usesmileid.com/products/onboarding-with-biometrics/document-verification.md

Performs a dynamic query against the documentation page to retrieve answers and relevant context.

```APIDOC
## GET /products/onboarding-with-biometrics/document-verification.md

### Description
Queries the documentation dynamically to retrieve an answer to a specific question, optionally tailored to a broader goal.

### Method
GET

### Endpoint
https://docs.usesmileid.com/products/onboarding-with-biometrics/document-verification.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /guides/migration-guides/enhanced-document-verification-mobile-integration-migration-guide-v10-v11-to-v12.md

Source: https://docs.usesmileid.com/guides/migration-guides/enhanced-document-verification-mobile-integration-migration-guide-v10-v11-to-v12.md

Queries the documentation page for specific information by providing a question and an optional goal.

```APIDOC
## GET /guides/migration-guides/enhanced-document-verification-mobile-integration-migration-guide-v10-v11-to-v12.md

### Description
Queries the current documentation page to retrieve answers to specific questions or to gather additional context.

### Method
GET

### Endpoint
https://docs.usesmileid.com/guides/migration-guides/enhanced-document-verification-mobile-integration-migration-guide-v10-v11-to-v12.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /guides/migration-guides/biometric-kyc-web-integration-migration-guide-v11-to-v12.md

Source: https://docs.usesmileid.com/guides/migration-guides/biometric-kyc-web-integration-migration-guide-v11-to-v12.md

Queries the documentation page for specific information using a natural language question.

```APIDOC
## GET /guides/migration-guides/biometric-kyc-web-integration-migration-guide-v11-to-v12.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, or sources based on a provided question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/guides/migration-guides/biometric-kyc-web-integration-migration-guide-v11-to-v12.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /developer-resources/sdks/web/web-sdk.md

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk.md

Queries the documentation for the Web SDK by providing a specific question and an optional goal.

```APIDOC
## GET /developer-resources/sdks/web/web-sdk.md

### Description
Perform an HTTP GET request on the documentation page URL to retrieve answers, excerpts, and sources related to a specific question about the Web SDK.

### Method
GET

### Endpoint
https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /developer-resources/sdks/web/web-sdk/setup.md

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk/setup.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /developer-resources/sdks/web/web-sdk/setup.md

### Description
Perform a dynamic query against the documentation to retrieve answers, relevant excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk/setup.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /developer-resources/sdks/web/web-components/setup.md

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-components/setup.md

Queries the documentation page dynamically to retrieve answers based on a specific question and optional goal.

```APIDOC
## GET /developer-resources/sdks/web/web-components/setup.md

### Description
Queries the documentation page dynamically to retrieve answers based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.usesmileid.com/developer-resources/sdks/web/web-components/setup.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /api-reference/set-up.md

Source: https://docs.usesmileid.com/api-reference/set-up

Queries the documentation for information by providing a specific question and an optional goal to refine the context of the response.

```APIDOC
## GET /api-reference/set-up.md

### Description
Performs a dynamic query against the documentation to retrieve answers and relevant excerpts.

### Method
GET

### Endpoint
https://docs.usesmileid.com/api-reference/set-up.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /developer-resources/essentials/verification-webhooks/webhook-types.md

Source: https://docs.usesmileid.com/developer-resources/essentials/verification-webhooks/webhook-types.md

Perform an HTTP GET request to query the documentation dynamically by asking a question.

```APIDOC
## GET /developer-resources/essentials/verification-webhooks/webhook-types.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.usesmileid.com/developer-resources/essentials/verification-webhooks/webhook-types.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### SmartSelfie Enrollment Implementation Comparison

Source: https://docs.usesmileid.com/guides/migration-guides/smartselfie-tm-enrollment-mobile-integration-migration-guide-v10-v11-to-v12.md

Compare the legacy v11 Composable initialization with the new v12 builder-based screen configuration.

```kotlin
// Before (v11, Android Compose):

SmileID.SmartSelfieEnrollment { result -> /* ... */ }

// After (v12, Android):

UseSmileIDBuilder { builder ->
    builder.network { /* jobType = JobType.SmartSelfieEnrollment, token, partnerConfig — see Step 2 */ }
    builder.ml { /* face analyzer — see Step 3 */ }

    builder.screens {
        consent {
            partnerName             = "Acme Corp"
            partnerPrivacyPolicyUrl = URL("https://acme.com/privacy")
            partnerIcon             = R.drawable.your_logo
        }
        instructions { }
        capture { captureType = CaptureType.SELFIE }
        preview { }
        processing { }
    }

    builder.onResult = { result -> /* see Step 5 */ }
}
```

--------------------------------

### GET /id-coverage/verify-with-id-number.md

Source: https://docs.usesmileid.com/id-coverage/verify-with-id-number.md

Query the documentation dynamically by performing an HTTP GET request on the documentation page URL.

```APIDOC
## GET /id-coverage/verify-with-id-number.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for additional information.

### Method
GET

### Endpoint
https://docs.usesmileid.com/id-coverage/verify-with-id-number.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Initialize Network Configuration with Backend Token

Source: https://docs.usesmileid.com/guides/migration-guides/smartselfie-tm-enrollment-mobile-integration-migration-guide-v10-v11-to-v12.md

Configure the network builder with a short-lived v3 token fetched from your backend and define partner parameters.

```kotlin
val samplePartnerParams: Map<String, String> = mapOf(
    "sample_flow" to "android",
    "demo" to "true",
)

builder.network {
    config { config ->
        config.jobType = JobType.SmartSelfieEnrollment
        config.token   = fetchTokenFromYourBackend()
        config.onTokenExpired = { previous -> fetchFreshToken() }
        config.partnerConfig { p ->
            p.partnerId   = "your-partner-id"
            p.callbackUrl = "https://example.com/callback"
            p.useSandbox  = true
            p.partnerParams = samplePartnerParams
        }
    }
}
```

--------------------------------

### GET /developer-resources/essentials/verification-webhooks/receive-webhooks/configure-your-webhook-server.md

Source: https://docs.usesmileid.com/developer-resources/essentials/verification-webhooks/receive-webhooks/configure-your-webhook-server.md

Perform an HTTP GET request to query the documentation for specific information using natural language.

```APIDOC
## GET /developer-resources/essentials/verification-webhooks/receive-webhooks/configure-your-webhook-server.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/developer-resources/essentials/verification-webhooks/receive-webhooks/configure-your-webhook-server.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /developer-resources/sdks/web/web-sdk/getting-result-of-a-verification.md

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk/getting-result-of-a-verification.md

Perform an HTTP GET request to query the documentation for specific information using the ask and goal parameters.

```APIDOC
## GET /developer-resources/sdks/web/web-sdk/getting-result-of-a-verification.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk/getting-result-of-a-verification.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Initialize the SDK

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk/setup.md

Configure and launch the Smile ID flow using the required token and partner details. All fields in partner_details are mandatory for biometric products.

```javascript
window.SmileIdentity({
  token,                                     // from Step 2
  product: 'biometric_kyc',
  callback_url: 'https://example.com/smile-webhook',
  environment: 'sandbox',                    // 'sandbox' or 'production'

  partner_details: {
    partner_id: 'your-partner-id',
    name: 'Acme Corp',
    logo_url: 'https://acme.example/logo.png',
    policy_url: 'https://acme.example/privacy',
    theme_color: '#001096',
  },

  onSuccess: () => {
    // Job submitted (202 Accepted). The verdict arrives on callback_url.
  },
  onClose: () => {
    // User closed the flow.
  },
  onError: (error) => {
    // error is a message string, e.g. 'SmileIdentity::ConsentDenied'
    console.error(error);
  },
});
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.usesmileid.com/developer-resources/essentials/testing-in-sandbox.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.usesmileid.com/developer-resources/essentials/testing-in-sandbox.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Implement Full SmartSelfie Enrollment Flow

Source: https://docs.usesmileid.com/guides/migration-guides/smartselfie-tm-enrollment-mobile-integration-migration-guide-v10-v11-to-v12.md

A complete example of the SmartSelfie Enrollment flow, including user details, screen configuration, network settings, and result handling.

```kotlin
@Composable
private fun SmartSelfieEnrollmentFlow(onComplete: () -> Unit) {
    val context = LocalContext.current

    val sampleUserDetails = UserDetails(
        givenNames = "John",
        lastName = "Doe",
        email = "test@smileidentity.com",
        phoneNumber = "+20000000000001",
    )

    val samplePartnerParams: Map<String, String> = mapOf(
        "sample_flow" to "android",
        "demo" to "true",
    )

    UseSmileIDBuilder {
        config { enableDebugMode = true }
        userDetails = sampleUserDetails
        screens {
            consent {
                partnerName = "Acme Corp"
                partnerPrivacyPolicyUrl = "https://acme.com/privacy"
                partnerIcon = R.drawable.your_logo
                showAttribution = true
            }
            instructions {}
            capture {
                captureType = CaptureType.SELFIE
                selfie {}
            }
            preview {}
            processing {}
        }
        ml {
            analyzers {
                forCaptureType(CaptureType.SELFIE) {
                    addAnalyzer(factory = FaceDetectorAnalyzer.Factory())
                    detectorMode = FaceDetectorMode.Default
                }
            }
        }
        network {
            config { config ->
                config.jobType = JobType.SmartSelfieEnrollment
                config.token   = fetchTokenFromYourBackend()
                config.onTokenExpired = { previous -> fetchFreshToken() }
                config.partnerConfig { p ->
                    p.partnerId   = "your-partner-id"
                    p.callbackUrl = "https://example.com/callback"
                    p.useSandbox  = true
                    p.partnerParams = samplePartnerParams
                }
            }
        }
        onResult = { result ->
            Timber.d("SmartSelfieEnrollment: $result")
            val message = when (result) {
                is UseSmileIDResult.Success -> "SmartSelfie Enrollment successful"
                UseSmileIDResult.Cancelled -> "SmartSelfie Enrollment cancelled"
                is UseSmileIDResult.Failure -> {
                    Timber.e(result.error)
                    "SmartSelfie Enrollment failed: ${result.error.message}"
                }
            }
            Toast.makeText(context, message, Toast.LENGTH_LONG).show()
            onComplete()
        }
        onAnalyticsEvent = { event ->
            Timber.d("SmartSelfieEnrollment Analytics: $event")
        }
    }
}
```

--------------------------------

### Get ID type availability status OpenAPI definition

Source: https://docs.usesmileid.com/api-reference/core-resources/services/id-availability.md

Defines the GET /v3/services/id_status endpoint, requiring country and id_type query parameters.

```json
{"openapi":"3.0.3","info":{"title":"V3 Services API","version":"1.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://testapi.smileidentity.com","description":"Sandbox"},{"url":"https://api.smileidentity.com","description":"Production"}],"security":[{"SmileIDToken":[]}],"components":{"securitySchemes":{"SmileIDToken":{"type":"apiKey","in":"header","name":"SmileID-Token","description":"JWT token obtained from `POST /v3/token`."}},"schemas":{"IdStatusResponse":{"type":"object","required":["last_checked","last_check_status","last_hour_success_rate","last_known_status","last_check_success_rate"],"properties":{"last_checked":{"type":"string","format":"date-time","description":"Timestamp of the most recent uptime check."},"last_check_status":{"type":"string","enum":["success","failure"],"description":"Whether the most recent check succeeded or failed."},"last_hour_success_rate":{"type":"string","description":"Aggregate success rate over the last hour as a percentage."},"last_known_status":{"type":"string","description":"The raw status string from the most recent check (e.g. \"online\", \"offline\")."},"last_check_success_rate":{"type":"string","description":"Success rate of the most recent individual check as a percentage."}}},"IdStatusErrorResponse":{"type":"object","required":["message","status"],"properties":{"message":{"type":"string","description":"Human-readable error message."},"status":{"type":"string","description":"HTTP status text (e.g. \"Bad Request\", \"Unauthorized\")."}}}}},"paths":{"/v3/services/id_status":{"get":{"operationId":"getIdStatus","tags":["Services"],"summary":"Get ID type availability status","description":"Returns the current availability and success rate for a specific ID type\nin a given country, based on uptime data from the last hour.\n\nRequires authentication via JWT token.\n","parameters":[{"name":"country","in":"query","required":true,"description":"ISO 3166-1 alpha-2 country code or full country name (e.g. \"NG\" or \"Nigeria\").","schema":{"type":"string"}},{"name":"id_type","in":"query","required":true,"description":"The ID type code to check status for (e.g. \"BVN\", \"NIN\", \"VOTER_ID\").","schema":{"type":"string"}}],"responses":{"200":{"description":"ID status retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdStatusResponse"}}}},"400":{"description":"Bad request – missing or invalid parameters, or no uptime data found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdStatusErrorResponse"}}}},"401":{"description":"Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdStatusErrorResponse"}}}}}}}}
```

--------------------------------

### GET /products/biometric-authentication/smartselfie-tm-registration.md

Source: https://docs.usesmileid.com/products/biometric-authentication/smartselfie-tm-registration.md

Queries the documentation for specific information using natural language.

```APIDOC
## GET /products/biometric-authentication/smartselfie-tm-registration.md

### Description
Queries the documentation dynamically by asking a question to retrieve direct answers and relevant excerpts.

### Method
GET

### Endpoint
https://docs.usesmileid.com/products/biometric-authentication/smartselfie-tm-registration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /id-coverage/verify-with-id-number/kenya.md

Source: https://docs.usesmileid.com/id-coverage/verify-with-id-number/kenya.md

Perform a query against the documentation to retrieve specific information or context.

```APIDOC
## GET /id-coverage/verify-with-id-number/kenya.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context related to a specific question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/id-coverage/verify-with-id-number/kenya.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Initialize SDK with Backend Token (Kotlin)

Source: https://docs.usesmileid.com/guides/migration-guides/document-verification-mobile-integration-migration-guide-v10-v11-to-v12.md

Configure the SDK builder with a backend-issued token and partner parameters. This replaces the legacy SmileID.initialize method.

```kotlin
val samplePartnerParams: Map<String, String> = mapOf(
    "sample_flow" to "android",
    "demo" to "true",
)

builder.network {
    config { config ->
        config.jobType = JobType.DocumentVerification
        config.token   = fetchTokenFromYourBackend()
        config.onTokenExpired = { previous -> fetchFreshToken() }
        config.partnerConfig { p ->
            p.partnerId   = "your-partner-id"
            p.callbackUrl = "https://example.com/callback"
            p.useSandbox  = true
            p.partnerParams = samplePartnerParams
        }
    }
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.usesmileid.com/api-reference/core-resources

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve specific information.

```http
GET https://docs.usesmileid.com/api-reference/core-resources.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /products/biometric-authentication/smartselfie-tm-compare.md

Source: https://docs.usesmileid.com/products/biometric-authentication/smartselfie-tm-compare.md

Queries the documentation for specific information using natural language.

```APIDOC
## GET /products/biometric-authentication/smartselfie-tm-compare.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a direct answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.usesmileid.com/products/biometric-authentication/smartselfie-tm-compare.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Request Example
GET https://docs.usesmileid.com/products/biometric-authentication/smartselfie-tm-compare.md?ask=How+do+I+integrate+SmartSelfie&goal=Authentication
```

--------------------------------

### GET /api-reference/core-resources/services/supported-id-types.md

Source: https://docs.usesmileid.com/api-reference/core-resources/services/supported-id-types.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /api-reference/core-resources/services/supported-id-types.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.usesmileid.com/api-reference/core-resources/services/supported-id-types.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Initialize eKYC SmartSelfie

Source: https://docs.usesmileid.com/developer-resources/sdks/web/web-sdk/performing-a-verification.md

Use the ekyc_smartselfie product string to initiate the SmartSelfie flow.

```javascript
window.SmileIdentity({
  token,
  product: 'ekyc_smartselfie',
  // ...everything else exactly as biometric_kyc
});
```

--------------------------------

### GET /api-reference/authentication.md

Source: https://docs.usesmileid.com/api-reference/authentication.md

Query the documentation dynamically by asking a question related to the API.

```APIDOC
## GET /api-reference/authentication.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
/api-reference/authentication.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.usesmileid.com/api-reference/core-resources/users.md

Use this request to ask specific questions about the documentation by providing an 'ask' parameter and an optional 'goal' parameter.

```http
GET https://docs.usesmileid.com/api-reference/core-resources/users.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw