### Reverse Resolve API Endpoint Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/reverse-resolver.md Example path for the GET request to resolve a specific wallet address. ```text api/v1/resolver/resolve/address/0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5 ``` -------------------------------- ### Resolve Zone Endpoint Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api.md Example path for the GET request to resolve a specific zone name. ```text api/v1/resolver/resolve/cederico.metaverse ``` -------------------------------- ### Fetch Available Chains Response Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/zone.md Example response for the GET /api/v1/reseller-logic/chains endpoint. ```json { "timestamp": "2024-06-12T11:23:15.614809", "data": [ "POLYGON" ] } ``` -------------------------------- ### UD Resolution Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md Example endpoint path for resolving a domain in the UD namespace. ```text e.g. api/v1/resolver/UD/free.xmr ``` -------------------------------- ### Get List of Profile Registries Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/profile-registry.md Example JSON response containing a list of all available profile registries. ```json { "timestamp": "2024-04-08T11:48:47.989561444", "size": 28274, "data": [ { "uuid": "ce8367d6-469e-456a-b936-96f1646b0b2b", "type": "REGISTRANT", "email": "0xb971823298ab509b93178322c3310902d052937c@ens.domains", "walletAddress": "0xb971823298ab509b93178322c3310902d052937c" }, { "uuid": "97ed9223-51cc-4b30-9be3-c8f62d980c70", "type": "REGISTRANT", "email": "0x143e87b164b054e3dca70a06543836f153805e21@ens.domains", "walletAddress": "0x143e87b164b054e3dca70a06543836f153805e21" }, { "uuid": "81a64953-dd98-423f-85ee-cec7f36f54dd", "type": "REGISTRAR", "name": "Unstoppable Domains", "organization": "Unstoppable Domains Inc.", "street": " 8465 W Sahara Ave Ste 111", "city": "Las Vegas", "postalCode": "NV 89117", "country": "United States", "phone": "", "fax": "", "email": "support@unstoppabledomains.com", "web": "https://unstoppabledomains.com", "walletAddress": "0xDA4f3b40Ad025DF3516C345919cff348F285e507" }, ... ] } ``` -------------------------------- ### Fetch All Users Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/user.md Example JSON response when retrieving the list of all users via the GET /api/v1/users endpoint. ```json { "timestamp": "2024-05-29T09:48:42.776555", "size": 4, "data": [ { "uuid": "b3cedc2d-3581-48bb-b588-42ad36bd2b1a", "name": "V****", "email": "v*@****.ch", "username": "v*****", "roleName": "ROLE_ADMIN", "createdAt": "2024-03-05T09:57:04.797901", "updatedAt": "2024-03-22T16:02:18.757387" }, { "uuid": "dee1f3b2-d268-4dc3-afba-469c14c61a7c", "name": "M****", "email": "m*@****.ch", "username": "m****", "roleName": "ROLE_USER", "createdAt": "2024-03-22T13:59:26.133148", "updatedAt": "2024-03-22T13:59:47.591019" }, { "uuid": "94ef5637-e744-427f-9854-db13a2e52489", "name": "T****", "email": "t***@****.com", "username": "Testing", "roleName": "ROLE_ADMIN", "createdAt": "2024-03-22T14:59:01.223698", "updatedAt": "2024-03-22T14:59:01.22371" }, { "uuid": "04d86365-69ac-4016-bad2-09ebd612358e", "name": "M****", "email": "m*@*****.ch", "username": "goodcode", "roleName": "ROLE_REGISTRAR", "createdAt": "2024-02-07T12:10:54.710621", "updatedAt": "2024-03-12T16:17:14.738392" } ] } ``` -------------------------------- ### FNS Resolution Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md Example endpoint path and corresponding JSON response for resolving a domain in the FNS namespace. ```text e.g. api/v1/resolver/FNS/davide.chain ``` ```json { "timestamp": "2025-03-05T14:49:59.504098117", "data": { "name": "davide.chain", "asciiName": "davide.chain", "level": "SLD", "namespace": "FNS", "network": "polygon", "tokenId": "90777953609510054281488883743633119686125636071182760521340225939732332499981", "owner": "0x47f22fee23c165231fa4ae22f5fb601c18097f6f", "resolvedAddress": null, "registrationDate": "2022-10-16T11:15:12.523", "expirationDate": null, "records": [ { "key": "record.CNAME.0", "type": "CNAME", "value": "cname.vercel-dns.com" }, { "key": "record.A.0", "type": "A", "value": "76.76.21.21" } ] } } ``` -------------------------------- ### POST /api/v1/zones/minting Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/zone.md Starts the minting process of a zone. ```APIDOC ## POST /api/v1/zones/minting ### Description Starts the minting process of a zone. ### Method POST ### Endpoint /api/v1/zones/minting ### Request Headers - **Authorization** (string) - Required - Bearer Token ### Request Body { "mintDetail": [ { "blockchain": "POLYGON", "name": "test.test" } ] } ### Response #### Success Response (200) - **timestamp** (string) - Timestamp of the response - **data** (array) - List of minted zone details #### Response Example { "timestamp": "2024-06-18T16:13:49.711173", "data": [ { "blockchain": "polygon-mumbai", "name": "test.test" } ] } ``` -------------------------------- ### Domain Resolution Response Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md Example JSON response for a domain resolution request, showing domain metadata and associated crypto/IPFS records. ```json { "timestamp": "2025-03-05T14:51:28.232227843", "data": { "name": "free.xmr", "asciiName": "free.xmr", "level": "SLD", "namespace": "UD", "network": "POLYGON", "tokenId": "49876188011878691066630568005647820382064440584891401385971285090972192179634", "owner": "0x9ce6ddab7e8a17025167367a47daa026fcc218eb", "resolvedAddress": "0x9ce6ddab7e8a17025167367a47daa026fcc218eb", "registrationDate": null, "expirationDate": null, "records": [ { "key": "crypto.SOL.address", "type": null, "value": "DhUbrEyq9bHwD9jf8bLcNCBNnmk8K3MV6QEkhVG3DGSD" }, { "key": "crypto.USDC.version.MATIC.address", "type": null, "value": "0x9ce6ddaB7E8A17025167367a47DAa026fCc218EB" }, { "key": "crypto.ETH.address", "type": null, "value": "0x9ce6ddaB7E8A17025167367a47DAa026fCc218EB" }, { "key": "crypto.BTC.address", "type": null, "value": "bc1qk3p9esfapts4yq59qwcgjudfump8e6enjy00kq" }, { "key": "crypto.MATIC.version.MATIC.address", "type": null, "value": "0x9ce6ddaB7E8A17025167367a47DAa026fCc218EB" }, { "key": "ipfs.html.value", "type": null, "value": "QmQLvsgTQToosdwZp2dWL1bKjBWtfy9zHqZX6yyzTDZ7yQ" } ] } } ``` -------------------------------- ### Registrant UUID Example Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/zone.md An example of a registrant UUID string. ```json "registrantUuid": "00023a69-7ac9-475f-bd85-360e9a05e2bc" ``` -------------------------------- ### ENS Resolution Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md Example endpoint path and corresponding JSON response for resolving an ENS domain. ```text e.g. api/v1/resolver/ENS/vitalik.eth ``` ```json { "timestamp": "2025-03-05T14:52:03.099267659", "data": { "name": "vitalik.eth", "asciiName": "vitalik.eth", "level": "SLD", "namespace": "ENS", "network": "ETHEREUM", "tokenId": "0xee6c4522aab0003e8d14cd40a6af439055fd2577951148c14b6cea9a53475835", "owner": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "resolvedAddress": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045", "registrationDate": "2017-06-18T08:39:14", "expirationDate": "2046-03-28T13:25:30", "records": [ { "key": "url", "type": null, "value": "https://vitalik.ca" }, { "key": "avatar", "type": null, "value": "https://euc.li/vitalik.eth" }, { "key": "description", "type": null, "value": "mi pinxe lo crino tcati" }, { "key": "com.twitter", "type": null, "value": "VitalikButerin" }, { "key": "com.github", "type": null, "value": "vbuterin" }, { "key": "header", "type": null, "value": "https://pbs.twimg.com/profile_banners/295218901/1638557376/1500x500" }, { "key": "60", "type": null, "value": "0xd8da6bf26964af9d7eed9e03e53415d37aa96045" } ] } } ``` -------------------------------- ### Get Single Profile Registry Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/profile-registry.md Example JSON response when fetching a single profile registry by its UUID. ```json { "timestamp": "2024-04-08T11:45:13.917384978", "data": { "uuid": "00023a69-7ac9-475f-bd85-360e9a05e2bc", "type": "REGISTRANT", "email": "0xd5324113327f083560a1e3f0f0d63dfa7229e674@ens.domains", "walletAddress": "0xd5324113327f083560a1e3f0f0d63dfa7229e674" } } ``` -------------------------------- ### GET /api/v1/white-label-logic/profile-registry/{walletAddress} Source: https://freename-1.gitbook.io/freename-apis/web3-white-label-apis/white-label-controller/profile-registries.md Fetches a profile registry by wallet address. ```APIDOC ## GET /api/v1/white-label-logic/profile-registry/{walletAddress} ### Description This API endpoint allows to fetch a profile registry by wallet address. ### Method GET ### Endpoint /api/v1/white-label-logic/profile-registry/{walletAddress} ### Parameters #### Path Parameters - **walletAddress** (string) - Required - The wallet address to look up ### Response #### Success Response (200) - **timestamp** (string) - Response timestamp - **data** (object) - Profile registry details ``` -------------------------------- ### Get List of Profile Registries by Type Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/profile-registry.md Example JSON response for a filtered list of profile registries. ```json { "timestamp": "2024-04-08T11:52:48.380725633", "size": 28269, "data": [ { "uuid": "ce8367d6-469e-456a-b936-96f1646b0b2b", "type": "REGISTRANT", "email": "0xb971823298ab509b93178322c3310902d052937c@ens.domains", "walletAddress": "0xb971823298ab509b93178322c3310902d052937c" }, { "uuid": "97ed9223-51cc-4b30-9be3-c8f62d980c70", "type": "REGISTRANT", "email": "0x143e87b164b054e3dca70a06543836f153805e21@ens.domains", "walletAddress": "0x143e87b164b054e3dca70a06543836f153805e21" }, ... ] } ``` -------------------------------- ### Search API Request and Response Source: https://freename-1.gitbook.io/freename-apis/web3-white-label-apis/white-label-controller/search.md Example of the GET request path and the corresponding JSON response structure for domain search queries. ```text api/v1/white-label-logic/search?searchString=test.influencer ``` ```json { "result": true, "data": { "result": [ { "type": "EXACT_MATCH", "elements": [ { "availabilityStatus": "AVAILABLE", "name": "test.influencer", "price": { "currency": "USD", "valueFormatted": "398.90" }, "url": "https://freename.io/results?search=%22test.influencer%22" } ] }, { "type": "SUGGESTED_TLD", "elements": [ { "availabilityStatus": "AVAILABLE", "name": ".question", "price": { "currency": "USD", "valueFormatted": "299.00" }, "url": "https://freename.io/results?search=%22.question%22" }, { "availabilityStatus": "AVAILABLE", "name": ".effect", "price": { "currency": "USD", "valueFormatted": "399.00" }, "url": "https://freename.io/results?search=%22.effect%22" }, { "availabilityStatus": "AVAILABLE", "name": ".essay", "price": { "currency": "USD", "valueFormatted": "499.00" }, "url": "https://freename.io/results?search=%22.essay%22" }, { "availabilityStatus": "AVAILABLE", "name": ".holistic", "price": { "currency": "USD", "valueFormatted": "299.00" }, "url": "https://freename.io/results?search=%22.holistic%22" } ] }, { "type": "SEARCH_STRING_AS_SECOND_LEVEL_DOMAIN", "elements": [ { "availabilityStatus": "AVAILABLE", "name": "test.investigation", "price": { "currency": "USD", "valueFormatted": "278.90" }, "url": "https://freename.io/results?search=%22test.investigation%22" }, { "availabilityStatus": "AVAILABLE", "name": "test.exam", "price": { "currency": "USD", "valueFormatted": "199.90" }, "url": "https://freename.io/results?search=%22test.exam%22" }, { "availabilityStatus": "AVAILABLE", "name": "test.investigate", "price": { "currency": "USD", "valueFormatted": "199.90" }, "url": "https://freename.io/results?search=%22test.investigate%22" }, { "availabilityStatus": "AVAILABLE", "name": "test.sinewy", "price": { "currency": "USD", "valueFormatted": "598.90" }, "url": "https://freename.io/results?search=%22test.sinewy%22" } ``` -------------------------------- ### Fetch All Registrars Response Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/profile-registries.md Example response body containing a list of registered entities. ```json { "timestamp": "2024-06-18T16:18:38.656077", "size": 10, "data": [ { "uuid": "81a64953-dd98-423f-85ee-cec7f36f54dd", "type": "REGISTRAR", "name": "Unstoppable Domains", "organization": "Unstoppable Domains Inc.", "street": " 8465 W Sahara Ave Ste 111", "city": "Las Vegas", "postalCode": "NV 89117", "country": "United States", "phone": "", "fax": "", "email": "support@unstoppabledomains.com", "web": "https://unstoppabledomains.com", "walletAddress": "0xDA4f3b40Ad025DF3516C345919cff348F285e507" }, { "uuid": "135336e1-c204-41bf-98d1-252ed3d25bd2", "type": "REGISTRAR", "name": "ENS Domains", "organization": "ENS Domains", "street": "Central Region", "city": "Singapore", "country": "Singapore", "phone": "+1 866 757 9231", "email": "press@ens.domains\n", "web": "https://ens.domains", "walletAddress": "0x4Fe4e666Be5752f1FdD210F4Ab5DE2Cc26e3E0e8" }, ... ] } ``` -------------------------------- ### Fetch Record Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/record.md Example response when fetching a record by its UUID. ```json { "timestamp": "2024-04-08T10:15:18.761587107", "data": { "uuid": "00002c83-280a-43f7-9874-ee9076cb6275", "type": "SOA", "name": "fffffff.com", "value": "ns1.fffffff.com hostmaster.fffffff.com 2024030601 3600 600 1209600 86400", "zoneUuid": "456548cb-f94f-4b64-8948-7a4b553a80d7", "ttl": 3300, "serial": 2024030601, "refresh": 3600, "retry": 600, "expire": 1209600, "version": "1.0", "mname": "ns1.fffffff.com", "rname": "hostmaster.fffffff.com" } } ``` -------------------------------- ### Fetch Zones of Logged User Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/zone.md Example JSON response for the GET /api/v1/zones/self endpoint, showing paginated zone data. ```json { "timestamp": "2024-05-29T09:11:15.624976", "size": 3, "page": 1, "totalElements": 7, "totalPages": 3, "data": [ { "uuid": "85a8eede-2efa-4976-93b4-8582bdcd57d0", "status": "OK", "name": "Test0", "asciiName": "Test0", "chain": "ETH", "registry": {}, "registrar": { "name": "****", "city": "****", "country": "****", "email": "info@****.com" }, "registrant": { "name": "****", "city": "Bengaluru", "country": "India", "email": "info@****.com" }, "registrationDate": "2024-07-10T08:30:00" }, { "uuid": "00ba86bb-e845-4cec-a8af-381124b32807", "status": "OK", "name": "Test01", "asciiName": "Test01", "chain": "ETH", "registry": {}, "registrar": { "name": "****", "city": "Bengaluru", "country": "India", "email": "info@****.com" }, "registrant": { "name": "****", "city": "Bengaluru", "country": "India", "email": "info@****.com" }, "registrationDate": "2024-07-10T08:30:00" }, { "uuid": "4da7db6a-df19-4a0f-9d77-ef1fdf3ec300", "status": "OK", "name": "Test16", "asciiName": "Test16", "chain": "ETH", "registry": {}, "registrar": { "name": "****", "city": "Bengaluru", "country": "India", "email": "info@****.com" }, "registrant": { "name": "****", "city": "Bengaluru", "country": "India", "email": "info@****.com" }, "registrationDate": "2024-07-10T08:30:00" } ] } ``` -------------------------------- ### Search API Request URL Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/search.md Example of the GET request URL structure with a searchString parameter containing multiple domain names. ```text api/v1/reseller-logic/search?searchString=test.influencer ciao.influencer abc.influencer ``` -------------------------------- ### Fetch Current User Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/user.md Example JSON response for the currently authenticated user. ```json { "timestamp": "2024-05-29T10:06:18.173313", "data": { "uuid": "b3cedc2d-3581-48bb-b588-42ad36bd2b1a", "name": "V*****", "email": "v*@*****.ch", "username": "v****", "roleName": "ROLE_ADMIN", "createdAt": "2024-03-05T09:57:04.797901", "updatedAt": "2024-03-22T16:02:18.757387" } } ``` -------------------------------- ### GET /api/v1/resolver/namespaces Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/utilities.md Fetches a list of available namespaces enabled for the tenant account. ```APIDOC ## GET /api/v1/resolver/namespaces ### Description Returns a list of namespaces enabled for the tenant account. The shortname field value is the enumeration value for the resolver with namespace endpoint. ### Method GET ### Endpoint /api/v1/resolver/namespaces ### Response #### Success Response (200) - **timestamp** (String) - The timestamp of the response - **data** (Array) - List of available namespaces #### Response Example { "timestamp": "2024-12-04T11:27:05.813793213", "data": [ { "name": "ENS Domains", "shortname": "ENS", "smartContractAddress": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85" } ] } ``` -------------------------------- ### GET /api/v1/reseller-logic/registrar Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/profile-registries.md Fetches a list of all available registrars. ```APIDOC ## GET /api/v1/reseller-logic/registrar ### Description This API endpoint allows users to fetch all registrars. ### Method GET ### Endpoint /api/v1/reseller-logic/registrar ### Parameters #### Request Headers - **Bearer Token** (string) - Required - The authorization token for accessing the API. ### Response #### Success Response (200) - **timestamp** (string) - Response timestamp - **size** (integer) - Number of registrars returned - **data** (array) - List of registrar objects ``` -------------------------------- ### GET /api/v1/white-label-logic/registrar Source: https://freename-1.gitbook.io/freename-apis/web3-white-label-apis/white-label-controller/profile-registries.md Fetches a list of all registrars. ```APIDOC ## GET /api/v1/white-label-logic/registrar ### Description This API endpoint allows users to fetch all registrars. ### Method GET ### Endpoint /api/v1/white-label-logic/registrar ### Response #### Success Response (200) - **timestamp** (string) - Response timestamp - **size** (integer) - Number of registrars returned - **data** (array) - List of registrar objects ``` -------------------------------- ### GET /api/v1/reseller-logic/profile-registry/{walletAddress} Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/profile-registries.md Fetches a profile registry associated with a specific wallet address. ```APIDOC ## GET /api/v1/reseller-logic/profile-registry/{walletAddress} ### Description This API endpoint allows to fetch a profile registry by wallet address. ### Method GET ### Endpoint /api/v1/reseller-logic/profile-registry/{walletAddress} ### Parameters #### Path Parameters - **walletAddress** (string) - Required - The wallet address to query #### Request Headers - **Bearer Token** (string) - Required - The authorization token for accessing the API. ### Response #### Success Response (200) - **timestamp** (string) - Response timestamp - **data** (object) - Profile registry details ``` -------------------------------- ### GET /api/v1/reseller-logic/zones/self Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/zone.md Fetches the zones associated with the current logged-in reseller. ```APIDOC ## GET /api/v1/reseller-logic/zones/self ### Description Fetches the zones associated with the current user. ### Method GET ### Endpoint /api/v1/reseller-logic/zones/self ``` -------------------------------- ### Zone Data Structure Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/zone.md Example of the JSON structure returned when querying zone information. ```json { "timestamp": "2024-05-29T08:46:28.423894", "size": 3, "page": 1, "totalPages": 3927, "data": [ { "uuid": "f21469c6-6ad5-4d8b-9332-3f0fb7cae879", "status": "OK", "name": "mattia.metaverse", "asciiName": "mattia.metaverse", "registry": {}, "registrar": { "name": "Freename", "street": "Samstagernstrasse 41", "city": "Wollerau", "postalCode": "8832", "country": "Switzerland", "phone": "", "email": "info@freename.io", "web": "https://freename.io", "walletAddress": "0xA1E885789C85FEFc76CC30236608B4A19A77e988" }, "registrant": { "name": "Freename", "street": "Samstagernstrasse 41", "city": "Wollerau", "postalCode": "8832", "country": "Switzerland", "phone": "", "email": "info@freename.io", "web": "https://freename.io", "walletAddress": "0xA1E885789C85FEFc76CC30236608B4A19A77e988" } },... ] } ``` -------------------------------- ### GET /api/v1/reseller-logic/minting/{zoneName} Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/zone.md Checks the current status of the minting process for a specific zone. ```APIDOC ## GET /api/v1/reseller-logic/minting/{zoneName} ### Description This API endpoint allows users to check the status of the minting process for a specific zone identified by its name. ### Method GET ### Endpoint /api/v1/reseller-logic/minting/{zoneName} ### Parameters #### Path Parameters - **zoneName** (string) - Required - The name of the zone to check. ### Request Headers - **Bearer Token** (string) - Required - The authorization token for accessing the API. ``` -------------------------------- ### GET /api/v1/white-label-logic/minting/{zoneName} Source: https://freename-1.gitbook.io/freename-apis/web3-white-label-apis/white-label-controller/zone.md Checks the current status of the minting process for a specific zone. ```APIDOC ## GET /api/v1/white-label-logic/minting/{zoneName} ### Description This API endpoint allows users to check the status of the minting process for a specific zone identified by its name. By sending a GET request with the zone name as a parameter, the response will indicate the current status of the minting process. ### Method GET ### Endpoint /api/v1/white-label-logic/minting/{zoneName} ### Parameters #### Path Parameters - **zoneName** (string) - Required - The name of the zone to check. ### Request Headers - **Authorization** (string) - Required - Bearer Token for accessing the API. ``` -------------------------------- ### GET /api/v1/reseller-logic/zones Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/zone.md Retrieves a paginated list of Web3 zones owned by the logged-in reseller. ```APIDOC ## GET /api/v1/reseller-logic/zones ### Description Retrieves Web3 zones owned by the logged-in reseller. The response includes metadata such as timestamp, page information, and an array of data objects representing individual web3 zones. ### Method GET ### Endpoint /api/v1/reseller-logic/zones ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number for pagination. Default value is 0. - **pageSize** (integer) - Optional - The page size for pagination. Default value is 25. - **sortBy** (string) - Optional - The field to sort the zones by. Default value is "name". ### Response #### Success Response (200) - **timestamp** (string) - Timestamp of the response. - **size** (integer) - Number of elements in the current page. - **page** (integer) - Current page number. - **totalElements** (integer) - Total number of elements available. - **totalPages** (integer) - Total number of pages. - **data** (array) - List of zone objects. ``` -------------------------------- ### Fetch Domain Details by Domain Name v2 Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md Example path for resolving a domain name using the FNS namespace. ```text api/v1/resolver/FNS/cederico.metaverse ``` -------------------------------- ### Fetch Profile Registry by Wallet Address Response Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/profile-registries.md Example response body for a successful lookup of a profile registry by wallet address. ```json { "timestamp": "2024-06-18T16:21:17.338821", "data": { "uuid": "94bfc7dc-...-fb287e626b74", "type": "REGISTRANT", "email": "example@freename.io", "walletAddress": "0x6721e82...ad2d07f" } } ``` -------------------------------- ### POST /login Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api.md Logs in the user with credentials to obtain an access token valid for one month. ```APIDOC ## POST /login ### Description Logs in the user in order to obtain an access token. The request body includes a username and password. ### Method POST ### Request Body - **username** (string) - Required - **password** (string) - Required ``` -------------------------------- ### GET /api/v1/users Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/user.md Retrieves a list of all users in the system. ```APIDOC ## GET /api/v1/users ### Description Retrieves information for all users. ### Method GET ### Endpoint /api/v1/users ### Response #### Success Response (200) - **timestamp** (string) - The time of the request. - **size** (integer) - The number of users returned. - **data** (array) - List of user objects. ``` -------------------------------- ### Resolver API Response Example Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md A sample JSON response showing the structure of resolved domain records, including token addresses and A records. ```json { "timestamp": "2024-08-22T09:27:44.830132", "data": { "host": "cederico.metaverse", "network": "POLYGON", "tld": "metaverse", "tokenId": "27852860280769187492768842851433555806350745604062440243777647496936527137670", "sld": "cederico", "isTld": false, "isSld": true, "records": [ { "key": "token.ETH.0", "type": "ETH", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.BTC.0", "type": "BTC", "value": "bc1qmklcz6knjtudu5vk535zegfk9xf4n0vg8tsv6n" }, { "key": "token.MATIC.0", "type": "MATIC", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.BNB.0", "type": "BNB", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.USDT.0", "type": "USDT", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.USDC.0", "type": "USDC", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.EUROC.0", "type": "EUROC", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.xDAI.0", "type": "xDAI", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.BUSD.0", "type": "BUSD", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "token.AURORA.0", "type": "AURORA", "value": "0x673c4F104F425BEB439EdeEF2e22bDFCEdAD0Ac5" }, { "key": "record.A.0", "type": "A", "value": "34.22.218.54" } ] } } ``` -------------------------------- ### GET /api/v1/profile_registries Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/profile-registry.md Fetches a list of all profile registries. ```APIDOC ## GET /api/v1/profile_registries ### Description Fetches a list of all profile registries. ### Method GET ### Endpoint /api/v1/profile_registries ### Response #### Success Response (200) - **timestamp** (string) - The time of the response. - **size** (integer) - The total count of registries. - **data** (array) - A list of profile registry objects. ``` -------------------------------- ### GET /api/v1/white-label-logic/zones/self Source: https://freename-1.gitbook.io/freename-apis/web3-white-label-apis/white-label-controller/zone.md Fetches the zones associated with the current user. ```APIDOC ## GET /api/v1/white-label-logic/zones/self ### Description Retrieves a list of zones associated with the currently authenticated user. ### Method GET ### Endpoint /api/v1/white-label-logic/zones/self ``` -------------------------------- ### POST /api/v1/reseller-logic/registrant Source: https://freename-1.gitbook.io/freename-apis/web3-reseller-apis-v.-1.0/reseller-logic/profile-registries.md Creates a new registrant profile. ```APIDOC ## POST /api/v1/reseller-logic/registrant ### Description This API endpoint allows users to create a registrant. ### Method POST ### Endpoint /api/v1/reseller-logic/registrant ### Parameters #### Request Headers - **Authorization** (string) - Required - Bearer {Authorization} #### Request Body - **name** (string) - Required - **organization** (string) - Required - **street** (string) - Required - **city** (string) - Required - **postalCode** (string) - Required - **country** (string) - Required - **phone** (string) - Required - **fax** (string) - Optional - **email** (string) - Required - **web** (string) - Optional - **dnsSec** (string) - Optional - **walletAddress** (string) - Required ### Request Example { "name": "Test-Registrant", "organization": "Goodcode", "street": "via Rime 33", "city": "Mendrisio", "postalCode": "6826", "country": "Switzerland", "phone": "+41782711212", "fax": "", "email": "goodcode@gmail.com", "web": "", "dnsSec": "", "walletAddress": "312317x1312321" } ### Response #### Success Response (201) - **timestamp** (string) - Creation timestamp - **data** (object) - Created registrant details ``` -------------------------------- ### GET /api/v1/resolver/FNS/{domainName} Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/resolver.md Resolve a specific domain by its name. ```APIDOC ## GET /api/v1/resolver/FNS/{domainName} ### Description Resolve a specific domain by its name. ### Method GET ### Endpoint /api/v1/resolver/FNS/{domainName} ### Parameters #### Path Parameters - **domainName** (string) - Required - The name of the domain to resolve. ### Response #### Success Response (200) - **timestamp** (string) - The timestamp of the response. - **data** (object) - The domain details including name, namespace, network, tokenId, owner, resolvedAddress, registrationDate, expirationDate, and records. ``` -------------------------------- ### Update Profile Registry Request and Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/profile-registry.md Example request body and corresponding response for updating a profile registry. ```json { "dnsSec": "YESDNS" } ``` ```json { "timestamp": "2024-04-08T12:11:23.240828955", "data": { "uuid": "00023a69-7ac9-475f-bd85-360e9a05e2bc", "type": "REGISTRANT", "email": "0xd5324113327f083560a1e3f0f0d63dfa7229e674@ens.domains", "dnsSec": "YESDNS", "walletAddress": "0xd5324113327f083560a1e3f0f0d63dfa7229e674" } } ``` -------------------------------- ### GET /api/v1/records/{record_uuid} Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/record.md Fetches a specific record by its UUID. ```APIDOC ## GET /api/v1/records/{record_uuid} ### Description Fetches a record by its UUID. ### Method GET ### Endpoint /api/v1/records/{record_uuid} ### Parameters #### Path Parameters - **record_uuid** (string) - Required - The unique identifier of the record. ``` -------------------------------- ### Fetch Available Resolution Namespaces Source: https://freename-1.gitbook.io/freename-apis/web3-resolution-api/utilities.md Retrieves a list of namespaces enabled for the tenant account, including their shortnames and smart contract addresses. ```json { "timestamp": "2024-12-04T11:27:05.813793213", "data": [ { "name": "ENS Domains", "shortname": "ENS", "smartContractAddress": "0x57f1887a8bf19b14fc0df6fd9b2acc9af147ea85" }, { "name": "Freename Domains", "shortname": "FNS", "smartContractAddress": "0x465ea4967479a96d4490d575b5a6cc2b4a4bee65" }, { "name": "Unstoppable Domains", "shortname": "UD", "smartContractAddress": "0xa9a6a3626993d487d2dbda3173cf58ca1a9d9e9f" } ] } ``` -------------------------------- ### GET /api/v1/zones/availability/{zone_name} Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/zone.md Check the availability of a specific zone name. ```APIDOC ## GET /api/v1/zones/availability/{zone_name} ### Description Check the availability of a zone name. ### Method GET ### Endpoint /api/v1/zones/availability/{zone_name} ### Parameters #### Path Parameters - **zone_name** (string) - Required - The name of the zone to check availability for. ### Response #### Success Response (200) - **timestamp** (string) - The timestamp of the response. - **data** (boolean) - Availability status of the zone. #### Response Example { "timestamp": "2024-05-29T09:21:12.87402", "data": false } ``` -------------------------------- ### Fetch User by Username or Role Response Source: https://freename-1.gitbook.io/freename-apis/web2-web3-mirroring-api/user.md Example JSON response when filtering users by username or role. ```json { "timestamp": "2024-05-29T10:06:18.173313", "data": { "uuid": "b3cedc2d-3581-48bb-b588-42ad36bd2b1a", "name": "V*****", "email": "v*@****.ch", "username": "v*****", "roleName": "ROLE_ADMIN", "createdAt": "2024-03-05T09:57:04.797901", "updatedAt": "2024-03-22T16:02:18.757387" } } ```