The Partner API v2 requires you to be authorized to access. To access the Partner API v2 and integrate it into your application, check our Set up Partner API Access guide.
This API endpoint is used for buying domains from UD. The blockchain needs time before a transaction is mined. In rare cases, it is possible for someone to front run your purchase, which would result in an order being cancelled. We expect this to happen in less than 1 out of 10000 cases. Please make sure you are using the 'Order Status' endpoint and wait until the transaction is mined. Endpoint requires one of the following: email, owner address, or useResellerCustodialWallet. If email is provided - domain will be linked to Unstoppable website account. If owner address is provided - domain will be minted right into crypto wallet. If ownerAddress is not provided and useResellerCustodialWallet = true, the domain will be minted to the reseller's custodial wallet. Optionally user can specify domain records that will be added to the domain once it's minted (i.e. if owner address is provided).
object (OrderPayment) Payment type and parameters | |
Array of objects (OrderSecurity) | |
Array of objects |
Successful
Bad Request
Partner Not Found
{- "payment": {
- "method": "stripe",
- "properties": {
- "tokenId": "tok_1FAeVFG8PQyZCUJhJp7emswP"
}
}, - "security": [
- {
- "type": "fingerprintjs",
- "identifier": "i2udKSvRFcN1wOqGLk3J"
}
], - "domains": [
- {
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "useResellerCustodialWallet": false,
- "email": "matt@unstoppabledomains.com",
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "resellerIdentityKey": "string"
}
]
}
{- "orderNumber": "-Lm9wiYytgrpf4YCWYv6",
- "payment": {
- "method": "stripe",
- "properties": {
- "tokenId": "tok_1FAeVFG8PQyZCUJhJp7emswP"
}
}, - "total": 0,
- "items": [
- {
- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "mintingTransaction": {
- "id": 2883,
- "blockchain": "MATIC",
- "networkId": 1,
- "hash": "0x5588e089b59458b4b34716c3299418e4ea449efbff35c8810f7c189160b1ed57",
- "blockExplorerUrl": "https://etherscan.io/tx/0x5698544cecaa05f7d155ff59fea48ef28cbd72068c7c3817987a19816d74fb9b",
- "statusGroup": "Pending"
}
}
]
}
Use this endpoint to pull the status of the order
Successful
Partner Not Found
Order Not Found
{- "orderNumber": "-Lm9wiYytgrpf4YCWYv6",
- "payment": {
- "method": "stripe",
- "properties": {
- "tokenId": "tok_1FAeVFG8PQyZCUJhJp7emswP"
}
}, - "total": 0,
- "items": [
- {
- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "mintingTransaction": {
- "id": 2883,
- "blockchain": "MATIC",
- "networkId": 1,
- "hash": "0x5588e089b59458b4b34716c3299418e4ea449efbff35c8810f7c189160b1ed57",
- "blockExplorerUrl": "https://etherscan.io/tx/0x5698544cecaa05f7d155ff59fea48ef28cbd72068c7c3817987a19816d74fb9b",
- "statusGroup": "Pending"
}
}
]
}
Check multiple domain names availability
Successful
Bad Request
Partner Not Found
{- "domains": [
- {
- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "availability": {
- "registered": false,
- "protected": false,
- "price": 1000,
- "availableForFree": false,
- "test": true
}
}
]
}
Check domain name availability
Successful
Bad Request
Partner Not Found
{- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "availability": {
- "registered": false,
- "protected": false,
- "price": 1000,
- "availableForFree": false,
- "test": true
}
}
This endpoint is used to provide domains variants based on provided domains and label. Method will provide domains similar to domains provided in domains parameter.
Valid
Bad Request
Partner Not Found
[- {
- "name": "thetest.crypto",
- "price": 20000
}, - {
- "name": "hellos.crypto",
- "price": 20000
}, - {
- "name": "thedomains.888",
- "price": 200000
}
]
This endpoint is used to provide free domains suggestions if a partner is eligible for free domains. If partner isn't eligible for free domains suggestions - endpoint will return error.
Valid
Bad Request
Partner Not Found
[- {
- "name": "thetest.crypto",
- "price": 20000
}, - {
- "name": "hellos.crypto",
- "price": 20000
}, - {
- "name": "thedomains.888",
- "price": 200000
}
]
Reserve free domain name for external user identifier. Usually it's a user identifier or email in a partner's system. Domain name becomes unavailable for selling and claiming to anyone except identity that reserved the domain. Only one domain could be reserved per resellerIdentityKey. Reserve time is 168 hours.
Valid
Bad Request
Partner Not Found
{- "resellerIdentityKey": "example@user.com"
}
{- "error": {
- "code": "ERROR_CODE",
- "message": "Error code explanation",
- "field": "some field",
- "value": "some value",
- "status": 400
}, - "constraints": [
- {
- "code": "ERROR_CODE",
- "message": "Error code explanation",
- "field": "some field",
- "value": "some value",
- "status": 400
}
]
}
Search for domain actions by user, domain or owner address.
Successful
{- "count": 1,
- "actions": [
- {
- "id": 12882,
- "domainName": "beresnev.crypto",
- "action": "UpdateRecords",
- "status": "Draft",
- "txs": [
- {
- "id": 2883,
- "blockchain": "MATIC",
- "status": "Draft",
- "signatureStatus": "Required",
- "gasUsed": 21000,
- "type": "Regular",
- "to": "0x801452cFAC27e79a11c6b185986fdE09e8637589",
- "data": "0xb88d4fde00000000000000000000000087348226e747df4cff2b1b1e38a528df405ccd5c000000000000000000000000070e83fced225184e67c86302493fffcdb953f7153b27892177c7f5b476966a119b206227e8155dc86269f932655df96e76d8803000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001"
}
]
}
]
}
Receives domain name, operation and parameters that needs to be performed on the blockchain. Example - set 'crypto.ETH.address' record for 'example.crypto' domain to '0xffff' value
Returns the list of transactions that need to be signed by the user in order to perform that operation and optionally a payment invoice in case user wants UD to compensate gas free for those transactions.
UpdateRecords
action that updates domain crypto records
Successful
Partner Not Found
Domain Not Found
{- "action": "UpdateRecords",
- "parameters": {
- "records": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "resetRecords": false
}, - "domain": "bogdangusiev.crypto",
- "gasCompensationPolicy": "CompensateFree"
}
{- "id": 12882,
- "action": "UpdateRecords",
- "status": "Draft",
- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "txs": [
- {
- "id": 2883,
- "blockchain": "MATIC",
- "status": "Draft",
- "signatureStatus": "Required",
- "gasUsed": 21000,
- "type": "Regular",
- "to": "0x801452cFAC27e79a11c6b185986fdE09e8637589",
- "data": "0xb88d4fde00000000000000000000000087348226e747df4cff2b1b1e38a528df405ccd5c000000000000000000000000070e83fced225184e67c86302493fffcdb953f7153b27892177c7f5b476966a119b206227e8155dc86269f932655df96e76d8803000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001"
}
], - "paymentInfo": {
- "id": "3882828",
- "clientSecret": "string",
- "totalAmount": 424
}, - "confirmCodes": [
- {
- "id": 34235,
- "expired": false,
- "authFactor": "email | otp",
- "userId": 12345
}
]
}
Receives domain action id. Returns the list of transactions that need to be signed by the user in order to perform that operation and optionally a payment invoice in case user wants UD to compensate gas free for those transactions.
Successful
Partner Not Found
Action Not Found
{- "id": 12882,
- "action": "UpdateRecords",
- "status": "Draft",
- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "txs": [
- {
- "id": 2883,
- "blockchain": "MATIC",
- "status": "Draft",
- "signatureStatus": "Required",
- "gasUsed": 21000,
- "type": "Regular",
- "to": "0x801452cFAC27e79a11c6b185986fdE09e8637589",
- "data": "0xb88d4fde00000000000000000000000087348226e747df4cff2b1b1e38a528df405ccd5c000000000000000000000000070e83fced225184e67c86302493fffcdb953f7153b27892177c7f5b476966a119b206227e8155dc86269f932655df96e76d8803000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001"
}
], - "paymentInfo": {
- "id": "3882828",
- "clientSecret": "string",
- "totalAmount": 424
}, - "confirmCodes": [
- {
- "id": 34235,
- "expired": false,
- "authFactor": "email | otp",
- "userId": 12345
}
]
}
Endpoint deprecated in favor of POST /actions/{actionId}/confirm
.
The new endpoint is fully compatible with the old one.
Successful
Partner Not Found
Action Not Found
[- {
- "id": 2883,
- "type": "Regular",
- "txHash": "0x5588e089b59458b4b34716c3299418e4ea449efbff35c8810f7c189160b1ed57"
}
]
{- "error": {
- "code": "RESELLER_NOT_FOUND",
- "message": "Reseller ID not found",
- "field": null,
- "value": null,
- "status": 401
}
}
A domain action requires the following to be performed:
signatureStatus: Required
expectssignature
for the case of Meta
transaction andtxHash
for the case of meta transactionThis endpoint is designed to let user submit the required data for an action to be executed.
Successful
Partner Not Found
Action Not Found
[- {
- "id": 2883,
- "type": "Regular",
- "txHash": "0x5588e089b59458b4b34716c3299418e4ea449efbff35c8810f7c189160b1ed57"
}
]
{- "error": {
- "code": "RESELLER_NOT_FOUND",
- "message": "Reseller ID not found",
- "field": null,
- "value": null,
- "status": 401
}
}
Receives domain name, operation and parameters that needs to be performed on the blockchain. Example - set 'crypto.ETH.address' record for 'example.crypto' domain to '0xffff' value
Returns the list of transactions that will be executed in order to perform that operation.
Successful
Partner Not Found
Domain Not Found
{- "action": "UpdateRecords",
- "parameters": {
- "records": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "resetRecords": false
}, - "domain": "bogdangusiev.crypto"
}
{- "id": 12882,
- "action": "UpdateRecords",
- "status": "Draft",
- "domain": {
- "id": 1001,
- "name": "matt.dao",
- "ownerAddress": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "resolver": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "registryAddress": "0x049aba7510f45BA5b64ea9E658E342F904DB358D",
- "networkId": 1,
- "resolution": {
- "crypto.ETH.address": "0x6EC0DEeD30605Bcd19342f3c30201DB263291589",
- "crypto.BTC.address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}, - "blockchain": "MATIC",
- "projectedBlockchain": "MATIC",
- "freeToClaim": true,
- "node": "0x756e4e998dbffd803c21d23b06cd855cdc7a4b57706c95964a37e24b47c10fc9"
}, - "txs": [
- {
- "id": 2883,
- "blockchain": "MATIC",
- "status": "Draft",
- "signatureStatus": "Required",
- "gasUsed": 21000,
- "type": "Regular",
- "to": "0x801452cFAC27e79a11c6b185986fdE09e8637589",
- "data": "0xb88d4fde00000000000000000000000087348226e747df4cff2b1b1e38a528df405ccd5c000000000000000000000000070e83fced225184e67c86302493fffcdb953f7153b27892177c7f5b476966a119b206227e8155dc86269f932655df96e76d8803000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001"
}
], - "paymentInfo": {
- "id": "3882828",
- "clientSecret": "string",
- "totalAmount": 424
}, - "confirmCodes": [
- {
- "id": 34235,
- "expired": false,
- "authFactor": "email | otp",
- "userId": 12345
}
]
}