1. Renewals
  • Overview
  • Endpoints
    • Companies
      • All companies
      • Get a company
      • Create company
      • Create payment
    • Pricing
      • Get pricing packages
    • Countries
      • All countries
      • Get a country
    • Forms
      • Get a form
    • Leads
      • All leads
      • Get a lead
      • Update status
    • Profile
      • Get profile
      • Update profile
    • Wallet
      • Get wallet balance
      • Create topup request
    • Support
      • All tickets
      • Get a ticket
      • Create a ticket
    • Notifications
      • All notifications
      • Mark as read
      • Pusher auth
    • Renewals
      • Search companies for renewal
        GET
      • Get dynamic form config for a jurisdiction
        GET
      • List renewal requests
        GET
      • Request a quote revision
        POST
      • Approve quote and confirm wallet payment
        POST
      • Initiate quote payment — send OTP
        POST
      • Get a renewal by ID
        GET
      • Submit a renewal request
        POST
    • Files
      • Get a one-time download URL for any file owned by the agent
    • Immigration
      • List immigration objectives
      • Submit an assessment and get matching programmes
      • Get application pre-fill
      • Create an application (draft or submitted)
      • List applications
      • Get an application
      • Update a draft (save again or submit)
      • Delete a draft
  • Schemas
    • QuoteConfig
    • CreatePaymentSuccessResponse
    • SuccessEnvelope
    • StandardSuccess
    • ErrorEnvelope
    • ErrorResponse
    • FieldValidation
    • DirectApplication
    • YesNo
    • FileAttachment
    • Company
    • QuoteBreakdown
    • Field
    • Objective
    • Quote
    • Section
    • AssessmentRequest
    • RenewalFormConfigBody
    • ProcessingStep
    • ProgrammeSummary
    • CreateCompanyRequest
    • ProgrammeMatch
    • RenewalFormConfig
    • CompletedDetails
    • ExternalCompany
    • ApplicationPrefill
    • Renewal
    • Applicant
    • FormConfigField
    • ApplicantFields
    • FormConfigSection
    • FamilyMember
    • FamilyMemberFields
    • FormConfig
    • Funds
    • DocumentMeta
    • Declarations
    • StoredDeclarations
    • ApplicationRequest
    • ApplicationStatus
    • Application
    • ApplicationDetail
    • CountryRef
    • CountryName
    • ApplicationListItem
  1. Renewals

Get a renewal by ID

Testing Env
https://demoapi.base93.com/api/v1/user/external/agent/
Testing Env
https://demoapi.base93.com/api/v1/user/external/agent/
GET
https://demoapi.base93.com/api/v1/user/external/agent/
renewals/{id}
Returns the full renewal record. Only accessible if the renewal belongs to the authenticated agent.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://demoapi.base93.com/api/v1/user/external/agent/renewals/664a1b2c3d4e5f6a7b8c9d0f' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Renewal detail
Bodyapplication/json

Example
{
    "status": true,
    "response_code": 200,
    "data": {
        "_id": "664a1b2c3d4e5f6a7b8c9d0f",
        "company": {
            "_id": "string",
            "proposed_name": "string",
            "country": {
                "_id": "string",
                "name": "string"
            },
            "type": "string",
            "freezone": "string"
        },
        "external_company": {
            "name": "Salesforce LLC",
            "country": "664a1b2c3d4e5f6a7b8c9d0e",
            "company_type": "LLC",
            "freezone": "IFZA"
        },
        "agent": {
            "_id": "string",
            "name": "string",
            "email": "string"
        },
        "renewal_type": "Trade License Renewal",
        "reference_id": "string",
        "status": "submitted",
        "quote": {
            "service": "Trade License Renewal",
            "timeline": "5 Working Days",
            "remarks": "Standard renewal — no changes required.",
            "jurisdiction": "string",
            "licence_no": "1234567",
            "breakdown": {
                "government_fees": 500,
                "service_fee": 250,
                "vat": 37.5,
                "total": 787.5
            },
            "documents": [
                {
                    "name": "trade-license.pdf",
                    "url": "https://base93uat.blob.core.windows.net/base93/renewal/trade-license.pdf",
                    "size": 204800
                }
            ],
            "quoted_at": "2019-08-24T14:15:22.123Z",
            "quoted_by": "string"
        },
        "processing_steps": [
            {
                "label": "Documents submitted to authority",
                "status": "pending",
                "completed_at": "2019-08-24T14:15:22.123Z"
            }
        ],
        "completed": {
            "documents": [
                {
                    "name": "trade-license.pdf",
                    "url": "https://base93uat.blob.core.windows.net/base93/renewal/trade-license.pdf",
                    "size": 204800
                }
            ],
            "notes": "string",
            "completed_at": "2019-08-24T14:15:22.123Z",
            "rating": 1,
            "review": "string"
        },
        "additional_fields": {
            "trade_license_number": "TL-2024-001234",
            "expiry_date": "2024-12-31"
        },
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}
🟠404
Modified at 2026-10-28 09:48:31
Previous
Initiate quote payment — send OTP
Next
Submit a renewal request
Built with