Skip to main content
Professional services

Integration Services

Hire OKIAS specialists for a defined verification integration. Submit requirements, complete technical review, approve an exact quotation and follow the project through delivery.

Use the guided request form for the normal customer journey. The endpoints below are public service-request workflows, not Developer KYC API endpoints and not a way to bypass product subscriptions or billing.

Starting scope, not unlimited development
The published catalogue controls the current starting package and its limits. Complex integrations and custom development require a separate quotation. No paid custom work starts before customer approval and verified payment settlement.

Published service catalogue

GET/v1/integration-services/catalogue

The response contains active catalogue entries and the current starting price. Public pages read this runtime catalogue rather than maintaining a conflicting hardcoded price. Inactive or quotation-only modules are not presented as activated commercial products.

Submit a request

POST/v1/integration-services/requests

Requests are rate limited and require a unique idempotencyKey. A same-key replay with identical details returns the original reference without creating another project. Reusing that key for different details is rejected. The anti-spam startedAt value is the browser form-start timestamp in milliseconds.

create-integration-request.sh
curl -X POST https://api.okias.io/v1/integration-services/requests \
  -H "Content-Type: application/json" \
  -d '{
    "customerType": "INDIVIDUAL",
    "fullName": "Example Customer",
    "email": "[email protected]",
    "country": "PK",
    "preferredContact": "EMAIL",
    "description": "Integrate Email OTP into an existing registration workflow.",
    "services": ["EMAIL_OTP"],
    "scope": ["SIMPLE_API"],
    "monthlyKycVolume": 0,
    "monthlyKybVolume": 0,
    "monthlyOtpVolume": 1000,
    "idempotencyKey": "replace-with-a-unique-request-id",
    "startedAt": 1794050000000
  }'

A new submission returns an ISR-YYYY-… reference and a strong guest tracking token. The token expires after 30 days and can be revoked. Do not publish it or place customer project data in URLs, logs or ordinary messages.

Verify the customer email

POST/v1/integration-services/verify-email
POST/v1/integration-services/track/resend-verification

The request email contains a separate 24-hour verification link. Its random token is stored only as a SHA-256 hash. Invalid and expired tokens return EMAIL_VERIFICATION_NOT_AVAILABLE. Requesting a fresh link invalidates earlier verification links. A tracking token alone cannot mark an email as verified.

Quotation acceptance and payment require a verified email. This is mailbox-ownership verification; it does not create a customer account or approve a commercial contract.

Secure tracking and communication

POST/v1/integration-services/track
POST/v1/integration-services/track/message
POST/v1/integration-services/track/attachments/:id

Send the tracking token in the JSON body, never as an attachment query parameter. Customers see only their own requirements, customer-visible events, tasks, quotes, payments, messages and attachment metadata. Internal staff notes are excluded.

Messages accept up to three PDF, PNG or JPEG files, 2 MB each. The API checks file signatures, encrypts objects at rest and decrypts them only after request-scoped authorization. A different customer cannot download the attachment. Authorized Admin and assigned integration staff have separate scoped download routes.

Quotation approval and payment

POST/v1/integration-services/track/quote-response
POST/v1/integration-services/track/payments

Quote actions are ACCEPT, CLARIFY and DECLINE. Acceptance is atomic and can occur only once for an unexpired prepared quote. If checkout creation fails, the accepted quote remains available for a payment retry without changing its approved scope.

Each quote has its own idempotent payment intent. Two equal-value quotes cannot share a checkout order. Signed provider settlement marks payment complete exactly once; replayed callbacks do not create another payment or credit-ledger entry. Administrative status controls cannot start paid work while the request remains unpaid.

White-label entitlement is separate
White-label integration requires the platform's centralized active entitlement on a verified OKIAS account. Hosted KYB or KYB API scope requires White-label Business or Enterprise. The integration engagement fee never includes or bypasses the required subscription.

Admin and staff boundaries

Super Admin catalogue, request management, quotation, assignment and reporting routes require their respective integration.* permissions. Integration engineering staff use integration.projects.work and can open only projects assigned to their staff profile. They cannot change approved commercial prices or read unrelated customer projects.

Operational figures are database-derived: statuses, pending actions, quoted value, verified paid revenue, conversion and completion time. New and high-value requests create operational alerts. Customer notifications use branded, logged OKIAS delivery; actual SMTP/provider acceptance is a separate operational check.

Common refusal codes

TRACKING_NOT_FOUND, EMAIL_VERIFICATION_REQUIRED, QUOTE_NOT_AVAILABLE, PAYMENT_REQUIRED, PAYMENT_NOT_CONFIGURED, INTEGRATION_COMMERCIAL_ACTIVATION_REQUIRED, WHITE_LABEL_SUBSCRIPTION_REQUIRED, WHITE_LABEL_BUSINESS_TIER_REQUIRED and PROJECT_NOT_ASSIGNED are explicit safe refusals. Payments remain disabled until the platform setting INTEGRATION_SERVICES_COMMERCIAL_ENABLED is deliberately activated after approval. An unavailable provider or unconfigured payment method must never be treated as a successful payment.