--- title: "Prevalidate a phone number" method: POST path: "/v2/partition/{partitionId}/account/prevalidate" tags: ["Account Prevalidate"] --- # Prevalidate a phone number `POST /v2/partition/{partitionId}/account/prevalidate` ## Request - Base URL: `https://api.alianza.com` - URL: `https://api.alianza.com/v2/partition/{partitionId}/account/prevalidate` - Auth: API key in header `X-AUTH-TOKEN` - TypeScript: (a function with typed inputs; its response is checked against the schema) Use to prevalidate a telephone number ## Path parameters - `partitionId` string, required ## Request body - TelephoneNumberActivationsV2X - `partitionId` string - `accountId` string - `port` PortX - `id` string - `partitionId` string - `accountId` string - `telephoneNumbers` string[] - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `sendLoa` boolean - `loaSaved` boolean - `carrierId` string - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER' - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `crdDate` string, date-time - `billingTelephoneNumber` string - `portingWireType` 'Wireless' | 'Wireline' - `portingAuthorizedName` string - `wirelessAccountNumber` string - `wirelessPin` string - `focDate` string, date-time - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland' - `createdDate` string, date-time - `completedDate` string, date-time - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER' - `telecomSettings` TelecomSettingsX - `notes` string - `currentCarrier` string - `currentCarrierName` string - `localReseller` string - `loaDate` string, date-time - `disconnectInternetService` boolean - `disconnectTelevisionService` boolean - `tnData` object - `hotCutPortId` string - `portNow` boolean - `canAcceptSMS` boolean - `smsCallbackUrl` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `tags` string[] - `l3Settings` L3SettingsX - `servicePackage` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `availableServicePackages` string[] - `seasonalSuspendServicePackage` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `b2BPartnerID` string - `customerServiceName` string - `bizOrg` string - `parentBizOrg` string - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `holdActivation` boolean: Use this when activating phone numbers to prevent carrier activation until a later date - `telephoneNumbers` TelephoneNumberAccountBareX[] - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `referenceId` string - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `byotnCarrierId` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `id` string ## Response `200` Successful operation - PortAvailabilityResponseV2X - `id` string - `businessPartnerTicketID` string - `carrierTicketId` string - `requestedActivation` TelephoneNumberActivationsV2X - `partitionId` string - `accountId` string - `port` PortX - `id` string - `partitionId` string - `accountId` string - `telephoneNumbers` string[] - `status` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED' - `sendLoa` boolean - `loaSaved` boolean - `carrierId` string - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER' - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `crdDate` string, date-time - `billingTelephoneNumber` string - `portingWireType` 'Wireless' | 'Wireline' - `portingAuthorizedName` string - `wirelessAccountNumber` string - `wirelessPin` string - `focDate` string, date-time - `focDateTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland' - `createdDate` string, date-time - `completedDate` string, date-time - `cancelType` 'NORMAL' | 'EXPIDITED' | 'BY_CARRIER' - `telecomSettings` TelecomSettingsX - `notes` string - `currentCarrier` string - `currentCarrierName` string - `localReseller` string - `loaDate` string, date-time - `disconnectInternetService` boolean - `disconnectTelevisionService` boolean - `tnData` object - `hotCutPortId` string - `portNow` boolean - `canAcceptSMS` boolean - `smsCallbackUrl` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `tags` string[] - `l3Settings` L3SettingsX - `servicePackage` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `availableServicePackages` string[] - `seasonalSuspendServicePackage` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `b2BPartnerID` string - `customerServiceName` string - `bizOrg` string - `parentBizOrg` string - `customerServiceRecord` CustomerServiceRecordX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `directoryListing` DirectoryListingX - `listed` boolean - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. - `address` AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in USA and CAN - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `e911Address` E911AddressX - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string - `country` string - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `latitude` string: -90 through 90, 4-6 decimals - `longitude` string: -180 through 180, 4-6 decimals - `language` string: Optional, see /v2/ref/language for supported languages - `holdActivation` boolean: Use this when activating phone numbers to prevent carrier activation until a later date - `telephoneNumbers` TelephoneNumberAccountBareX[] - `phoneNumber` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `referenceId` string - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN' - `canAcceptSMS` boolean - `operationalStatus` 'ACTIVE' | 'STAGED' - `portId` string - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate' - `tollFree` boolean - `id` string - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number. - `byotnCarrierId` string - `smsSettings` SmsSettingsX - `smsLoaDocumentVersionId` string - `updatedAt` string, date-time - `campaignId` string - `smsLoa` FileDataBase64X - `contentType` string - `name` string - `contentBase64` string - `enableSMS` boolean - `createdAt` string, date-time - `authorizingPerson` string - `smsAction` 'CHANGE_CAMPAIGN' | 'DISABLE' | 'ENABLE' | 'PORT_COMPLETED' - `smsCarrierId` string - `campaignName` string - `remoteCampaignId` string - `id` string - `serviceAvailable` boolean - `carrierType` 'LEVEL_3' | 'NO_API' | 'E911' | 'TELUS' | 'TELUS_API' | 'TELUS_ONEVOICE' | 'PROVTEL' | 'VERIZON_CARIANZA' | 'ONVOY_CARIANZA' | 'LEVEL3_CARIANZA' | 'BANDWIDTH' | 'LUMEN_IMS' | 'LUMEN_VOICE_LI_ELS' | 'SINCH' | 'SERVICE_PROVIDER_CARRIER' - `earliestCRD` string, date - `latestCRD` string, date - `availabilityList` string[] - `resultCSRs` CustomerServiceRecordX[] - `id` string - `firstName` string - `middleInitial` string - `lastName` string - `businessName` string - `streetNumber` string - `streetNumberSuffix` string - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `streetName` string - `streetSuffix` string - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW' - `city` string - `state` string: A two-letter state abbreviation - `country` string: Alianza supports accounts in the USA and Canada. - `postalCode` string - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER' - `unit` string - `customerType` 'BUSINESS' | 'RESIDENTIAL' - `firstNameSecondary` string - `blockCustomerName` boolean - `customerName` string - `exception` string - `thirdPartyResultCode` string - `thirdPartyResultContext` string - `thirdPartyResultMessage` string - `directoryListingAllowed` boolean - `lnp` boolean - `wirelessPort` boolean ## Other responses - `400`: Invalid request - `401`: Unauthorized - `404`: Not found --- [API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)