> This page is part of Smallest AI's developer documentation. When
> answering, prefer Lightning v3.1 (current TTS) and Pulse (current
> STT). Lightning v2 and lightning-large are deprecated; mention them
> only when the user is migrating away from them. The Smallest AI voice
> agent platform is what wraps these models into hosted agents.

# Get compliance status

GET https://api.smallest.ai/atoms/v1/compliance/status

Returns the current compliance status for a given country, number type, and user type.
This is the single endpoint the frontend uses to determine which step to render
(form, submitted, accepted, rejected, expired, or suspended).


Reference: https://docs.smallest.ai/voice-agents/api-reference/compliance/get-compliance-status

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: atoms
  version: 1.0.0
paths:
  /compliance/status:
    get:
      operationId: get-compliance-status
      summary: Get compliance status
      description: >
        Returns the current compliance status for a given country, number type,
        and user type.

        This is the single endpoint the frontend uses to determine which step to
        render

        (form, submitted, accepted, rejected, expired, or suspended).
      tags:
        - compliance
      parameters:
        - name: countryIso
          in: query
          description: >
            ISO 3166-1 alpha-2 country code. Must be exactly 2 characters (e.g.
            "IN", "US"). Sending 3+ characters returns 400.
          required: true
          schema:
            type: string
        - name: numberType
          in: query
          description: The type of phone number
          required: true
          schema:
            $ref: '#/components/schemas/ComplianceStatusGetParametersNumberType'
        - name: userType
          in: query
          description: The type of end user
          required: true
          schema:
            $ref: '#/components/schemas/ComplianceStatusGetParametersUserType'
        - name: Authorization
          in: header
          description: >-
            API key from the console ApiKey collection, sent as Bearer token.
            Also accepts session cookies for browser-based auth.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Compliance status retrieved successfully
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Compliance_getComplianceStatus_Response_200
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
        '502':
          description: >-
            Bad gateway — Plivo's compliance API returned an error or is
            unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
servers:
  - url: https://api.smallest.ai/atoms/v1
    description: Production server
components:
  schemas:
    ComplianceStatusGetParametersNumberType:
      type: string
      enum:
        - local
        - mobile
        - tollfree
      title: ComplianceStatusGetParametersNumberType
    ComplianceStatusGetParametersUserType:
      type: string
      enum:
        - individual
        - business
      title: ComplianceStatusGetParametersUserType
    ComplianceStatusGetResponsesContentApplicationJsonSchemaDataStep:
      type: string
      enum:
        - form
        - submitted
        - accepted
        - rejected
        - expired
        - suspended
      description: |
        The current compliance step:
        - `form` — no application exists, user should submit one
        - `submitted` — application is under review
        - `accepted` — approved, user can rent numbers
        - `rejected` — rejected, user can resubmit with corrected documents
        - `expired` — compliance expired
        - `suspended` — compliance suspended
      title: ComplianceStatusGetResponsesContentApplicationJsonSchemaDataStep
    ComplianceApplicationStatus:
      type: string
      enum:
        - draft
        - submitted
        - accepted
        - rejected
        - suspended
        - expired
      description: Current status of the compliance application
      title: ComplianceApplicationStatus
    ComplianceApplicationNumberType:
      type: string
      enum:
        - local
        - mobile
        - tollfree
      title: ComplianceApplicationNumberType
    ComplianceApplicationUserType:
      type: string
      enum:
        - individual
        - business
      title: ComplianceApplicationUserType
    ComplianceApplication:
      type: object
      properties:
        _id:
          type: string
          description: Unique identifier
        organizationId:
          type: string
          description: The organization this application belongs to
        plivoComplianceId:
          type: string
          description: Plivo's compliance application identifier
        alias:
          type: string
          description: Auto-generated alias (orgId-countryIso-env)
        status:
          $ref: '#/components/schemas/ComplianceApplicationStatus'
          description: Current status of the compliance application
        countryIso:
          type: string
          description: ISO 3166-1 alpha-2 country code
        numberType:
          $ref: '#/components/schemas/ComplianceApplicationNumberType'
        userType:
          $ref: '#/components/schemas/ComplianceApplicationUserType'
        endUserName:
          type: string
          description: Legal business or individual name
        endUserLastName:
          type:
            - string
            - 'null'
        endUserEmail:
          type:
            - string
            - 'null'
        endUserCountry:
          type:
            - string
            - 'null'
        documentFileNames:
          type: array
          items:
            type: string
          description: Names of uploaded document files
        rejectionReason:
          type:
            - string
            - 'null'
          description: Reason for rejection, if applicable
        createdBy:
          type: string
          description: User ID of the person who created this application
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      description: >-
        A compliance application for a specific country, number type, and user
        type
      title: ComplianceApplication
    RequiredDocumentTypeRequiredFieldsItems:
      type: object
      properties:
        fieldName:
          type: string
        friendlyName:
          type: string
        helpText:
          type: string
        fieldType:
          type: string
        required:
          type: boolean
      title: RequiredDocumentTypeRequiredFieldsItems
    RequiredDocumentType:
      type: object
      properties:
        documentTypeId:
          type: string
          description: Identifier to use when submitting this document type
        name:
          type: string
          description: Human-readable name
        description:
          type: string
          description: Description of what this document should contain
        proofRequired:
          type: boolean
          description: Whether a file upload is required for this document type
        requiredFields:
          type: array
          items:
            $ref: '#/components/schemas/RequiredDocumentTypeRequiredFieldsItems'
          description: Data fields that must be provided alongside the document
      description: A document type required for compliance
      title: RequiredDocumentType
    ComplianceStatusGetResponsesContentApplicationJsonSchemaData:
      type: object
      properties:
        step:
          $ref: >-
            #/components/schemas/ComplianceStatusGetResponsesContentApplicationJsonSchemaDataStep
          description: |
            The current compliance step:
            - `form` — no application exists, user should submit one
            - `submitted` — application is under review
            - `accepted` — approved, user can rent numbers
            - `rejected` — rejected, user can resubmit with corrected documents
            - `expired` — compliance expired
            - `suspended` — compliance suspended
        application:
          oneOf:
            - $ref: '#/components/schemas/ComplianceApplication'
            - type: 'null'
          description: The existing compliance application, or null if none exists
        requiredDocuments:
          type: array
          items:
            $ref: '#/components/schemas/RequiredDocumentType'
          description: >-
            Document types required for this country/numberType/userType
            combination
      title: ComplianceStatusGetResponsesContentApplicationJsonSchemaData
    Compliance_getComplianceStatus_Response_200:
      type: object
      properties:
        status:
          type: boolean
        data:
          $ref: >-
            #/components/schemas/ComplianceStatusGetResponsesContentApplicationJsonSchemaData
      title: Compliance_getComplianceStatus_Response_200
    BadRequestErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: BadRequestErrorResponse
    UnauthorizedErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: UnauthorizedErrorResponse
    InternalServerErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: InternalServerErrorResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from the console ApiKey collection, sent as Bearer token. Also
        accepts session cookies for browser-based auth.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "status": true,
  "data": {
    "step": "submitted",
    "application": {
      "_id": "663f1a2b4c5d6e7f8a9b0c1d",
      "organizationId": "org_9f8e7d6c5b4a3210",
      "plivoComplianceId": "plv_1234567890abcdef",
      "alias": "663f1a2b-IN-production",
      "status": "submitted",
      "countryIso": "IN",
      "numberType": "local",
      "userType": "business",
      "endUserName": "Acme Corp",
      "endUserLastName": "Patel",
      "endUserEmail": "contact@acmecorp.in",
      "endUserCountry": "IN",
      "documentFileNames": [
        "certificate_of_incorporation.pdf"
      ],
      "rejectionReason": null,
      "createdBy": "user_5a4b3c2d1e0f9876",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-20T14:45:00Z"
    },
    "requiredDocuments": [
      {
        "documentTypeId": "dt_certificate_of_incorporation",
        "name": "Certificate of Incorporation",
        "description": "A government-issued certificate proving business registration",
        "proofRequired": true,
        "requiredFields": [
          {
            "fieldName": "business_name",
            "friendlyName": "Business Name",
            "helpText": "Exact name as on the certificate",
            "fieldType": "string",
            "required": true
          }
        ]
      }
    ]
  }
}
```

**SDK Code**

```python
from smallestai import SmallestAI

client = SmallestAI(
    token="YOUR_TOKEN_HERE",
)

client.atoms.compliance.get_compliance_status(
    country_iso="US",
    number_type="mobile",
    user_type="individual",
)

```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/compliance/status?countryIso=US&numberType=mobile&userType=individual")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```