Partner API

Overview

The base URL is your registry host followed by /api/v1.

https://domains.pagejar.com/api/v1

• Requests and responses are JSON. Send Accept: application/json on every call.
• Registering and renewing are asynchronous. The call returns 202 and you read the domain until its status settles.
• A token only sees its own partner's domains. An owner partner's token sees all.

Quick start: search a name, then register it.

curl -s "https://domains.pagejar.com/api/v1/domains/check?name=example&tlds[]=com&tlds[]=com.bd" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json"

Authentication

Create a token in the admin under Partners. It is shown once, so store it in a secret manager. Send it as a bearer token:

Authorization: Bearer <token>

Keep the token on your server. Never put it in browser code or a mobile app. If one leaks, delete it in Partners and create a new one.

Requests and responses

• Domain names are lowercase, full names such as example.com.bd. Case is ignored in paths and on registration.
• Dates are UTC, ISO 8601, for example 2026-11-12T10:00:00.000000Z.
• Arrays in query strings use tlds[]=com&tlds[]=net.
• Pagination on lists is 50 per page with Laravel's page fields (data, current_page, last_page, next_page_url, total). Add ?page=2.
• No idempotency key. Registering the same name twice returns 422, so a retry after a timeout is safe. Read the domain first to see what happened.

Errors

Errors are JSON with a message. Validation errors add an errors object keyed by field.

{
  "message": "example.com is already in the registry.",
  "errors": { "name": ["example.com is already in the registry."] }
}

{ "message": "Invalid nameserver", "retryable": false }

Rate limits

• 120 requests per minute per token on every endpoint.
• 30 requests per minute per token on Check availability and Check a transfer, as well.
• 20 requests per minute per token on Send an auth code.

Over the limit you get 429 with a Retry-After header. Responses carry X-RateLimit-Limit and X-RateLimit-Remaining. Search up to 30 names per call rather than one call per name.

Check availability

Send either a label and the endings to try, or full names. Each name goes to the registrar for its ending.

curl -s "https://domains.pagejar.com/api/v1/domains/check?domains[]=example.com&domains[]=example.com.bd" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json"

{
  "data": [
    { "domain": "example.com",    "provider": "orderbox", "in_registry": false, "available": true,  "premium": false },
    { "domain": "example.com.bd", "provider": "get_bd",   "in_registry": false, "available": false, "premium": false },
    { "domain": "example.xyz",    "provider": "orderbox", "in_registry": false, "available": null,  "error": "No answer for example.xyz" }
  ]
}

Register a domain

Queues the registration. Read Get a domain until status is active or failed. With import: true nothing is bought; the domain is only recorded as active so the registry can track it.

Registrant

What each registrar needs:

• get.bd (.bd): name, nid, email and a Bangladeshi phone. The order may wait in pending_documents while get.bd reviews documents.
• OrderBox (everything else): registrant is optional. Without it the registry's default contact is used.
• Dynadot: name, email, phone and country.

curl -s -X POST "https://domains.pagejar.com/api/v1/domains" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{
    "name": "example.com.bd",
    "years": 1,
    "nameservers": ["ns1.procloudify.com", "ns2.procloudify.com"],
    "external_ref": "whmcs-domain-1234",
    "registrant": {
      "name": "Rahim Uddin", "email": "rahim@example.com",
      "phone_cc": "880", "phone": "01712345678",
      "address1": "House 1, Road 2", "city": "Dhaka", "state": "Dhaka",
      "postcode": "1207", "country": "BD", "nid": "1234567890"
    }
  }'

const res = await fetch("https://domains.pagejar.com/api/v1/domains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.REGISTRY_TOKEN}`,
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ name: "example.com", years: 1 }),
});
if (res.status !== 202) throw new Error((await res.json()).message);
const domain = await res.json(); // status: "pending"

$res = Http::withToken(config('services.registry.token'))
    ->acceptJson()
    ->post('https://domains.pagejar.com/api/v1/domains', [
        'name' => 'example.com',
        'years' => 1,
    ]);
$res->throw();           // 422 / 502 raise here
$domain = $res->json();  // status: "pending"

Response 202 is the domain object. A failed domain of yours can be posted again to retry with new details. A name held by anyone else returns 422.

List domains

curl -s "https://domains.pagejar.com/api/v1/domains?status=active&q=example" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json"

Get a domain

{
  "id": 12,
  "partner_id": 2,
  "name": "example.com.bd",
  "tld": "com.bd",
  "provider": "get_bd",
  "status": "active",
  "years": 1,
  "nameservers": ["ns1.procloudify.com", "ns2.procloudify.com"],
  "provider_order_id": "ord_123",
  "external_ref": "whmcs-domain-1234",
  "registered_at": "2026-11-12T10:00:00.000000Z",
  "expires_at": "2027-11-12T00:00:00.000000Z",
  "synced_at": "2026-11-12T10:01:00.000000Z",
  "last_error": null,
  "kind": "register",
  "transfer_status": null,
  "created_at": "2026-11-12T09:59:30.000000Z",
  "updated_at": "2026-11-12T10:01:00.000000Z"
}

Poll every 5 to 10 seconds for the first minute, then every few minutes. get.bd orders waiting on documents can take hours, so stop polling and check once a day instead. last_error explains a failed status or a failed renewal. kind is register or transfer; transfer_status is the registrar's own words while a transfer is in progress.

Renew a domain

curl -s -X POST "https://domains.pagejar.com/api/v1/domains/example.com/renew" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{"years": 1}'

{ "message": "Renewal queued.", "domain": { "name": "example.com", "status": "active", "...": "..." } }

Only active or expired domains can be renewed; others return 409. A second renewal request for the same domain inside 10 minutes also returns 409, so a retry cannot pay twice. The renewal is tried once. Compare expires_at before and after, and check last_error if it did not move.

Change nameservers

curl -s -X PUT "https://domains.pagejar.com/api/v1/domains/example.com/nameservers" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{"nameservers": ["ns1.example.net", "ns2.example.net"]}'

Only active domains can change nameservers; others return 409. This runs at the registrar before the response returns, so it can take a few seconds. It returns the updated domain, or 502 with the registrar's message.

Sync from the registrar

Reads status, expiry and nameservers from the registrar now and returns the domain. The registry also refreshes every domain about once a day, so you only need this right after a change made outside the API.

Check a transfer

Asks the registrar that would take the domain whether it can be transferred in. Only OrderBox and Dynadot take transfers; a .bd name is refused with 422.

curl -s "https://domains.pagejar.com/api/v1/transfers/check?name=example.com" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json"

{ "name": "example.com", "provider": "orderbox", "transferable": true, "message": null }

transferable is true, false (see message, for example a name that is not registered at all), or null when the registrar cannot tell before the order is placed (Dynadot).

Transfer a domain in

Moves a domain from another registrar to yours. The order is paid and includes one year of renewal. Before you call it, unlock the domain at the current registrar and get its auth (EPP) code. The order is placed on the queue.

curl -s -X POST "https://domains.pagejar.com/api/v1/transfers" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{ "name": "example.com", "auth_code": "Abc123!xyz", "nameservers": ["ns1.a.com", "ns2.a.com"], "external_ref": "pagejar-77" }'

Follow it

Read Get a domain. kind is transfer and status goes pending, then transferring while the old registrar and the owner approve, then active (or failed). transfer_status shows the registrar's own words, for example "Waiting for Domain-Secret" or "Validating domain transfer", and last_error says what to fix. Check every few hours, not every few seconds.

Send an auth code

Gives a waiting transfer a new auth code. Returns the domain.

curl -s -X PUT "https://domains.pagejar.com/api/v1/transfers/example.com/auth-code" \
  -H "Authorization: Bearer $TOKEN" -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{ "auth_code": "NewCode1!" }'

Domain statuses

Registrars and endings

The routing table is managed in the admin under TLD routing.

Going live

• Searches always work. Registering and renewing against a live registrar needs the registry owner to switch live purchases on.
• Test against the sandbox first. Sandbox answers are test data and can differ from live.
• Treat available: null as "not sure", never as "taken" or "free".
• Store the returned name and your own external_ref, and reconcile with GET /domains after any timeout.
• Handle 429 with the Retry-After header, and 502 by its retryable flag.