Bitcall logoBitcall API
Add your Key ID and Secret to send test requests.

Check a job

GET
/v1/hlr/lookups/jobs/{jobId}

Returns a job's status, per-outcome counts and price. Poll this after submitting.

Authorization

KeyId ApiSecret
x-key-id<token>

Your API key id.

In: header

x-api-secret<token>

Your API key secret.

In: header

Path Parameters

jobId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/hlr/lookups/jobs/string"
{
  "data": {
    "jobId": "string",
    "status": "queued",
    "counts": {
      "input": 0,
      "processed": 0,
      "accepted": 0,
      "rejected": 0,
      "failed": 0
    },
    "actions": {
      "canCancel": true,
      "canExport": true
    },
    "lookupType": "string",
    "category": "string",
    "productCode": "string",
    "name": "string",
    "price": {
      "amount": 0,
      "currency": "string"
    },
    "startedAt": "string",
    "completedAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request is not valid. See `fields` for what to correct.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "AUTHENTICATION_REQUIRED",
    "message": "This endpoint requires an API key.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "No such resource.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Retry after the interval in `Retry-After`.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Something went wrong on our side.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_RESPONSE_INVALID",
    "message": "The upstream service returned an unexpected response.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "The service is temporarily unavailable. Try again shortly.",
    "requestId": "9f1c7b2e-…"
  }
}