Interactive Playground credentials

Enter your Console OAuth credentials to test API requests in the playground below. Select OmaxTelecom Client Credentials as the auth identity before sending.

Client IDClient Secret

Phone Numbers API

KYC

Download schema

Organization and per-number KYC submissions

Get per-number KYC submission

GET

https://api.omaxtelecom.com/numbers

/{phoneNumberId}/kyc

Get per-number KYC submission › path Parameters

phoneNumberId

string · uuid · required

Get per-number KYC submission › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Get per-number KYC submission › Responses

Latest per-number KYC submission

success

boolean · enum · required

Enum values:

PhoneNumberKycSubmission · required

Submit per-number KYC

POST

https://api.omaxtelecom.com/numbers

/{phoneNumberId}/kyc

Submit per-number KYC › path Parameters

phoneNumberId

string · uuid · required

Submit per-number KYC › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Submit per-number KYC › Request Body

SubmitKycRequest

data

object · required

KYC payload fields as required by your regulator

documents

string[]

URLs to supporting documents

Submit per-number KYC › Responses

KYC submitted

success

boolean · enum · required

Enum values:

PhoneNumberKycSubmission · required

POST/{phoneNumberId}/kyc

curl https://api.omaxtelecom.com/numbers/:phoneNumberId/kyc \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "use_case": "customer_support",
    "end_user_type": "business",
    "company_name": "Acme Telecom Ltd"
  },
  "documents": [
    "https://storage.example.com/docs/reg-form.pdf"
  ]
}'

Example Request Body

{
  "data": {
    "use_case": "customer_support",
    "end_user_type": "business",
    "company_name": "Acme Telecom Ltd"
  },
  "documents": [
    "https://storage.example.com/docs/reg-form.pdf"
  ]
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "b8c9d0e1-f2a3-4567-bcde-678901234567",
    "phone_number_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "pending",
    "data": {
      "use_case": "customer_support",
      "end_user_type": "business"
    },
    "documents": [
      "https://storage.example.com/docs/reg-form.pdf"
    ],
    "submitted_at": "2026-09-17T10:00:00+00:00",
    "reviewed_at": null,
    "rejection_reason": null
  }
}

json

application/json

Get organization KYC submission

GET

https://api.omaxtelecom.com/numbers

/kyc/organization

Get organization KYC submission › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Get organization KYC submission › Responses

Latest organization KYC submission

success

boolean · enum · required

Enum values:

KycSubmission · required

Submit organization KYC

POST

https://api.omaxtelecom.com/numbers

/kyc/organization

Submit organization KYC › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Submit organization KYC › Request Body

SubmitKycRequest

data

object · required

KYC payload fields as required by your regulator

documents

string[]

URLs to supporting documents

Submit organization KYC › Responses

KYC submitted

success

boolean · enum · required

Enum values:

KycSubmission · required

POST/kyc/organization

curl https://api.omaxtelecom.com/numbers/kyc/organization \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "company_name": "Acme Telecom Ltd",
    "registration_number": "12345678",
    "country": "GB",
    "address": "1 Telecom Way, London"
  },
  "documents": [
    "https://storage.example.com/docs/certificate.pdf",
    "https://storage.example.com/docs/id-proof.pdf"
  ]
}'

Example Request Body

{
  "data": {
    "company_name": "Acme Telecom Ltd",
    "registration_number": "12345678",
    "country": "GB",
    "address": "1 Telecom Way, London"
  },
  "documents": [
    "https://storage.example.com/docs/certificate.pdf",
    "https://storage.example.com/docs/id-proof.pdf"
  ]
}

json

application/json

Example Responses

{
  "success": true,
  "data": {
    "id": "a7b8c9d0-e1f2-3456-abcd-567890123456",
    "status": "pending",
    "data": {
      "company_name": "Acme Telecom Ltd",
      "registration_number": "12345678",
      "country": "GB"
    },
    "documents": [
      "https://storage.example.com/docs/certificate.pdf"
    ],
    "submitted_at": "2026-09-17T10:00:00+00:00",
    "reviewed_at": null,
    "rejection_reason": null
  }
}

json

application/json

Endpoints

Get per-number KYC submission

GET

https://api.omaxtelecom.com/numbers

/{phoneNumberId}/kyc

Get per-number KYC submission › path Parameters

phoneNumberId

string · uuid · required

Get per-number KYC submission › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Get per-number KYC submission › Responses

Latest per-number KYC submission

success

boolean · enum · required

Enum values:

PhoneNumberKycSubmission · required

Submit per-number KYC

POST

https://api.omaxtelecom.com/numbers

/{phoneNumberId}/kyc

Submit per-number KYC › path Parameters

phoneNumberId

string · uuid · required

Submit per-number KYC › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Submit per-number KYC › Request Body

SubmitKycRequest

data

object · required

KYC payload fields as required by your regulator

documents

string[]

URLs to supporting documents

Submit per-number KYC › Responses

KYC submitted

success

boolean · enum · required

Enum values:

PhoneNumberKycSubmission · required

Get organization KYC submission

GET

https://api.omaxtelecom.com/numbers

/kyc/organization

Get organization KYC submission › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Get organization KYC submission › Responses

Latest organization KYC submission

success

boolean · enum · required

Enum values:

KycSubmission · required

Submit organization KYC

POST

https://api.omaxtelecom.com/numbers

/kyc/organization

Submit organization KYC › Headers

X-Organization-Id

string

Keycloak organization ID for M2M clients whose token does not include an organization claim.

Submit organization KYC › Request Body

SubmitKycRequest

data

object · required

KYC payload fields as required by your regulator

documents

string[]

URLs to supporting documents

Submit organization KYC › Responses

KYC submitted

success

boolean · enum · required

Enum values:

KycSubmission · required