Register Domain
Important
Before registering a domain in production, you will need to download the domain association file and host it at /.well-known/apple-developer-merchantid-domain-association on your site.
When Apple verifies a domain, it makes a request to retrieve the domain association file.
Request
URL
The request is completed by a POST to the above URL's with these headers:
| HTTP Header | |||
|---|---|---|---|
| Field Name | State | Data Type | Description |
| Content-Type | Mandatory | String | application/json |
| Authorization | Mandatory | String | Bearer access_token |
With this parameter:
| HTTP Path Parameter | |||
|---|---|---|---|
| Field Name | Data Type | Description | |
| merchantId | String | DNA Payments merchant ID. E.g. 70407064-b70d-46a1-8aba-931c4891e25c You can find this with a GET Merchants query to our separate Reporting API. | |
And the payload as shown here:
| POST | |||
|---|---|---|---|
| Field Name | Data Type | State | Description |
| domainNames | String | Mandatory | An array of objects, each one as below. Items must be unique. The API is limited to 99 domain names per request. |
| string | String | Mandatory | A fully qualified domain name/subdomain including the “www.” if applicable. E.g. example.com, www.shop.example.com. DON’T include “https://” in the domain name. |
If successful, this method returns the 200 OK response code with an empty body.
Request Example
{
"domainNames": [
"www.shop.example.com",
"shop.example.com",
"example.com"
]
}