API Setup BETA

Get started in three steps

Current access: Existing COD, indicator and AI Caller betas require signed-in OVERC merchants. The separate B2C pre-dispatch check uses manually approved partner keys. No anonymous public keys, automatic partner approval, calls or customer-score lookups are offered by this setup page.

COD pre-dispatch check API Partner beta

An online seller sends the customer's name, mobile number and delivery address plus their own order ID. OVERC returns an advisory payment-history color (green, yellow, red or gray) to help the seller decide whether to dispatch a COD order.

Different from a COD confirmation call: This API does not phone the buyer, confirm the order, validate identity, check address deliverability, or guarantee payment. Those actions require separate verification services. A gray result means insufficient eligible network history.

Valid requests returning any color, including gray, count as successful checks. Retries using the same partner order ID do not incur another charge. Invalid/blocked requests are not billed. After the first year, paid usage is blocked until a partner's billing arrangement is explicitly activated. GST and invoice terms require commercial agreement.

curl -X POST 'https://overc.in/api/cod-dispatch-check' \
  -H 'X-OVERC-API-Key: YOUR_APPROVED_PARTNER_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": "ORDER-12345",
    "customer_name": "Example Customer",
    "mobile": "BUYER_MOBILE_10_DIGITS",
    "delivery_address": "Example full delivery address, city, PIN",
    "buyer_notice_acknowledged": true
  }'

The seller must provide an appropriate notice to the customer before the check. Only eligible, buyer-consented independent shop records may contribute to the color. The name and address are validated as supplied fields but are not independently verified or retained in the usage log.

Apply for partner access

Sign in with an existing OVERC merchant account. Applications require manual business and privacy approval. API keys are issued only after approval and shown once. Do not put API keys in website JavaScript, mobile apps or public repositories—use your own backend server.

Checking your signed-in OVERC merchant account…

Choose your API

Each service requires an explicit request. The OVERC payment indicator is optional; COD orders can be confirmed without it.

curl -X POST 'https://overc.in/api/overc-call' \
  -H 'Authorization: Bearer YOUR_MERCHANT_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "kind": "cod",
    "phone": "BUYER_MOBILE_10_DIGITS",
    "customer_name": "Example Customer",
    "order_amount": 1499,
    "items": "Example item",
    "address": "Example delivery address",
    "seller_name": "Example Shop",
    "consent": true
  }'

curl -X POST 'https://overc.in/api/overc-score' \
  -H 'Authorization: Bearer YOUR_MERCHANT_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "BUYER_MOBILE_10_DIGITS",
    "include_score": true
  }'

curl -X POST 'https://overc.in/api/overc-call' \
  -H 'Authorization: Bearer YOUR_MERCHANT_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "kind": "reminder",
    "deal_token": "YOUR_OWN_OVERDUE_DEAL_TOKEN",
    "consent": true
  }'

curl 'https://overc.in/api/overc-call' \
  -H 'Authorization: Bearer YOUR_MERCHANT_ACCESS_TOKEN' \
  -H 'X-Call-Status-Ticket: STATUS_TICKET_FROM_CALL'

Authentication and responsible use

Use a valid OVERC signed-in merchant access token as a bearer token for the current beta endpoints. Your integration must protect that token and respect its expiry. Never embed a merchant token, service-role key, or secret in a public site or source repository.

For server-to-server B2C pre-dispatch checks only, verified partners may receive revocable keys after manual approval. Other integrations (COD voice, AI Payment Caller, partner webhooks, billing collection and invoices) still require their own technical, legal and commercial approval. Never use merchant login tokens as public API keys.

Do not test by dialing a real customer without their permission. The example phone numbers, names and values above are placeholders only; pressing Copy does not send requests.