TEtelgea
Port-Ins

Get port-in fields for a country

Retrieves the dynamic form fields required to submit a number port-in for a given country. Different countries and providers require different information (e.g., authorization codes, account numbers, personal details).

The response is keyed by port-in type (e.g., "personal", "business"). Each type contains a human-readable label and an array of input field definitions with validation rules.

Each type also carries the market's transfer date as executionDate and how a port-in into the market runs as timing. Both hold for the whole market, and repeat in every type because the response is keyed by type.

Use this endpoint to build dynamic forms that collect the right data before submitting a port-in.

get/v1/port-ins/fields/{countryCode}

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Path parameters

countryCodestring required

ISO 3166-1 alpha-2 country code (e.g., "DK", "US", "GB")

Example:DE

Response

Successfully retrieved port-in field definitions for the specified country. The response is keyed by port-in type (e.g., personal, business). Each type contains a human-readable label and an array of field definitions describing the inputs required for that port-in type.

Field types are text, select, date, number and checkbox. Each carries only the constraints that apply to it: minLength, maxLength and regex on text; options on select; minDate, maxDate, dates and validUntil on date; min, max and decimalPlaces on number; requiredValue on checkbox. Any field can carry help, howToGet and an example of its format.

executionDate is a date field whose dates are every date a port-in can happen on, as of today in the market's time zone. They hold until validUntil, the market's next midnight; fetch the fields again after it.

GetPortInFieldsResponse required

Changes

No recorded changes to this operation across all 1 revision of this API.