--- title: Create Registration --- [Skip to content](#%5Ftop) [API Reference](https://developers.cloudflare.com/api) [Registrar Sandbox](https://developers.cloudflare.com/api/resources/registrar%5Fsandbox) [Registrations](https://developers.cloudflare.com/api/resources/registrar%5Fsandbox/subresources/registrations) Copy Markdown Open in **Claude** Open in **ChatGPT** Open in **Cursor** --- **Copy Markdown** **View as Markdown** # Create Registration POST/accounts/{account\_id}/registrar-sandbox/registrations Starts a domain registration workflow. ### Prerequisites * The account must not already be at the maximum supported domain limit. A single account may own up to 500 domains in total across registrations created through either the dashboard or this API. * The domain must be on a supported extension for programmatic registration. * Use `POST /domain-check` immediately before calling this endpoint to confirm real-time availability and pricing. ### Defaults * `years`: defaults to the extension’s minimum registration period (1 year for most extensions, but varies — for example, `.ai` (if supported) requires a minimum of 2 years). * `auto_renew`: defaults to `false`. Setting it to `true` is an explicit opt-in authorizing Cloudflare to charge the account’s default payment method up to 30 days before domain expiry to renew the registration. Renewal pricing may change over time based on registry pricing. * `privacy_mode`: defaults to `redaction`. ### Premium domains Premium domain registration is not currently supported by this API. If `POST /domain-check` returns `tier: premium`, do not call this endpoint for that domain. ### Response behavior By default, the server holds the connection for a bounded, server-defined amount of time while the registration completes. Most registrations finish within this window and return `201 Created` with a completed workflow status. If the registration is still processing after this synchronous wait window, the server returns `202 Accepted`. Poll the URL in `links.self` to track progress. To skip the wait and receive an immediate `202`, send `Prefer: respond-async`. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**`X-Auth-Email: user@example.com` The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194` ##### Path ParametersExpand Collapse account\_id: string Identifier. maxLength32 ##### Header ParametersExpand Collapse Prefer: optional string ##### Body ParametersJSONExpand Collapse domain\_name: string Provides a fully qualified domain name (FQDN), including the extension (e.g., `example.com`, `mybrand.app`). The domain name uniquely identifies a registration. Cloudflare permits only one registration per domain, making the domain name a natural idempotency key for registration requests. acknowledgements: optional map\[unknown\] Provides user acknowledgements for a specific extension or premium registration flow. The extension registration schema from the extension discovery endpoint identifies the required keys. auto\_renew: optional boolean Enable or disable automatic renewal. Defaults to `false` if omitted. Setting this field to `true` is an explicit opt-in authorizing Cloudflare to charge the account’s default payment method up to 30 days before domain expiry to renew the domain automatically. Renewal pricing may change over time based on registry pricing. contact\_extensions: optional map\[unknown\] Provides registry-specific contact extension values for the registrant. `GET /accounts/{account_id}/registrar/extensions/{extension}` identifies the required keys and allowed values for each extension in the `registration_schema.properties.contact_extensions` object. Examples include `.us` nexus fields, `.uk` registrant type fields, and `.ca` legal type fields. Omit this object when the extension’s registration schema excludes `contact_extensions`. contacts: optional object { administrator, billing, registrant, technical } Provides contact data for the registration request. The per-extension schema from `GET /accounts/{account_id}/registrar/extensions/{extension}` defines the accepted contact roles. Every currently supported extension requires only `contacts.registrant` from API callers. Callers may provide additional roles such as `technical`, `administrator`, and `billing` when the extension schema includes them. When a registry requires an omitted role, Cloudflare may derive that contact from `contacts.registrant`. When the request omits either the entire `contacts` object or `contacts.registrant`, the system uses the account’s default address book entry as the registrant contact. The account owner must configure this default at `https://dash.cloudflare.com/{account_id}/domains/registrations`, where they can create or update the address book entry and accept the required agreement. Dashboard settings currently provide the only way to manage address book entries. Without either a default address book entry or a registrant contact, the registration request fails validation. administrator: optional object { email, phone, postal\_info, fax } Optional administrator contact. Accepted only when the extension schema includes this role. When the registry requires an omitted contact, Cloudflare may derive it from `contacts.registrant`. email: string Email address for the registrant. Used for domain-related communications from the registry, including ownership verification and renewal notices. formatemail phone: string Phone number in E.164 format: `+{country_code}.{number}` without spaces or dashes. Examples: `+1.5555555555` (US), `+44.2071234567` (UK), `+81.312345678` (Japan). postal\_info: object { address, name, organization } Postal/mailing information for the contact. The `name` field is the complete contact name in one string. Some registries require a complete personal name, including a family or last name where applicable, but this API does not accept separate first-name and last-name fields for registration contacts. address: object { city, country\_code, postal\_code, 2 more } Physical mailing address for the registrant contact. city: string City or locality name. country\_code: string Two-letter country code per ISO 3166-1 alpha-2 (e.g., `US`, `GB`, `CA`, `DE`). postal\_code: string Postal or ZIP code. state: string State, province, or region. Use the standard abbreviation where applicable (e.g., `TX` for Texas, `ON` for Ontario). street: string Street address including building/suite number. name: string Full legal name of the contact, including all required name components for an individual or authorized representative. Some registries require a complete personal name that includes a family or last name where applicable. Provide the complete name in this single field, for example `Ada Lovelace`; do not send separate first-name or last-name fields. organization: optional string Organization or company name. Optional for individual registrants. fax: optional string Fax number in E.164 format (e.g., `+1.5555555555`). Optional. Most registrations do not require a fax number. billing: optional object { email, phone, postal\_info, fax } Optional billing contact. Accepted only when the extension schema includes this role. When the registry requires an omitted contact, Cloudflare may derive it from `contacts.registrant`. email: string Email address for the registrant. Used for domain-related communications from the registry, including ownership verification and renewal notices. formatemail phone: string Phone number in E.164 format: `+{country_code}.{number}` without spaces or dashes. Examples: `+1.5555555555` (US), `+44.2071234567` (UK), `+81.312345678` (Japan). postal\_info: object { address, name, organization } Postal/mailing information for the contact. The `name` field is the complete contact name in one string. Some registries require a complete personal name, including a family or last name where applicable, but this API does not accept separate first-name and last-name fields for registration contacts. address: object { city, country\_code, postal\_code, 2 more } Physical mailing address for the registrant contact. city: string City or locality name. country\_code: string Two-letter country code per ISO 3166-1 alpha-2 (e.g., `US`, `GB`, `CA`, `DE`). postal\_code: string Postal or ZIP code. state: string State, province, or region. Use the standard abbreviation where applicable (e.g., `TX` for Texas, `ON` for Ontario). street: string Street address including building/suite number. name: string Full legal name of the contact, including all required name components for an individual or authorized representative. Some registries require a complete personal name that includes a family or last name where applicable. Provide the complete name in this single field, for example `Ada Lovelace`; do not send separate first-name or last-name fields. organization: optional string Organization or company name. Optional for individual registrants. fax: optional string Fax number in E.164 format (e.g., `+1.5555555555`). Optional. Most registrations do not require a fax number. registrant: optional object { email, phone, postal\_info, fax } Optional registrant contact. If omitted, the account’s default address book entry is used instead. email: string Email address for the registrant. Used for domain-related communications from the registry, including ownership verification and renewal notices. formatemail phone: string Phone number in E.164 format: `+{country_code}.{number}` without spaces or dashes. Examples: `+1.5555555555` (US), `+44.2071234567` (UK), `+81.312345678` (Japan). postal\_info: object { address, name, organization } Postal/mailing information for the contact. The `name` field is the complete contact name in one string. Some registries require a complete personal name, including a family or last name where applicable, but this API does not accept separate first-name and last-name fields for registration contacts. address: object { city, country\_code, postal\_code, 2 more } Physical mailing address for the registrant contact. city: string City or locality name. country\_code: string Two-letter country code per ISO 3166-1 alpha-2 (e.g., `US`, `GB`, `CA`, `DE`). postal\_code: string Postal or ZIP code. state: string State, province, or region. Use the standard abbreviation where applicable (e.g., `TX` for Texas, `ON` for Ontario). street: string Street address including building/suite number. name: string Full legal name of the contact, including all required name components for an individual or authorized representative. Some registries require a complete personal name that includes a family or last name where applicable. Provide the complete name in this single field, for example `Ada Lovelace`; do not send separate first-name or last-name fields. organization: optional string Organization or company name. Optional for individual registrants. fax: optional string Fax number in E.164 format (e.g., `+1.5555555555`). Optional. Most registrations do not require a fax number. technical: optional object { email, phone, postal\_info, fax } Optional technical contact. Accepted only when the extension schema includes this role. When the registry requires an omitted contact, Cloudflare may derive it from `contacts.registrant`. email: string Email address for the registrant. Used for domain-related communications from the registry, including ownership verification and renewal notices. formatemail phone: string Phone number in E.164 format: `+{country_code}.{number}` without spaces or dashes. Examples: `+1.5555555555` (US), `+44.2071234567` (UK), `+81.312345678` (Japan). postal\_info: object { address, name, organization } Postal/mailing information for the contact. The `name` field is the complete contact name in one string. Some registries require a complete personal name, including a family or last name where applicable, but this API does not accept separate first-name and last-name fields for registration contacts. address: object { city, country\_code, postal\_code, 2 more } Physical mailing address for the registrant contact. city: string City or locality name. country\_code: string Two-letter country code per ISO 3166-1 alpha-2 (e.g., `US`, `GB`, `CA`, `DE`). postal\_code: string Postal or ZIP code. state: string State, province, or region. Use the standard abbreviation where applicable (e.g., `TX` for Texas, `ON` for Ontario). street: string Street address including building/suite number. name: string Full legal name of the contact, including all required name components for an individual or authorized representative. Some registries require a complete personal name that includes a family or last name where applicable. Provide the complete name in this single field, for example `Ada Lovelace`; do not send separate first-name or last-name fields. organization: optional string Organization or company name. Optional for individual registrants. fax: optional string Fax number in E.164 format (e.g., `+1.5555555555`). Optional. Most registrations do not require a fax number. privacy\_mode: optional "off" or "redaction" Sets the WHOIS privacy mode for the registration. Defaults to `redaction`. * `off`: Disables WHOIS privacy. * `redaction`: Requests WHOIS redaction where the extension supports it. Some extensions exclude privacy and redaction. One of the following: "off" "redaction" years: optional number Sets the registration term from 1 to 10 years. When omitted, this field defaults to the registry’s minimum registration period for the extension. Most extensions require 1 year, while some require longer minimum terms (e.g., `.ai` requires 2 years). Each registry may also enforce its own maximum registration term. A request above that maximum fails. When uncertain, omit this field to use the default. maximum10 minimum1 ##### ReturnsExpand Collapse errors: array of object { code, message, source } code: number minimum1000 message: string source: optional object { pointer } Location of the invalid value that caused the error. pointer: string JSON Pointer to the invalid or missing request value. messages: array of object { code, message, source } code: number minimum1000 message: string source: optional object { pointer } Location of the invalid value that caused the error. pointer: string JSON Pointer to the invalid or missing request value. result: object { completed, created\_at, links, 4 more } Status of an async registration workflow. completed: boolean Indicates whether the workflow reached a terminal state. A `succeeded` or `failed` state returns `true`; `pending`, `in_progress`, `action_required`, and `blocked` return `false`. created\_at: string formatdate-time links: object { self, resource } self: string URL to this status resource. resource: optional string URL to the domain resource. state: "pending" or "in\_progress" or "action\_required" or 3 more Describes the workflow lifecycle state. * `pending`: The workflow awaits processing. * `in_progress`: Processing started. Continue polling `links.self`. An internal deadline limits the duration of this state. * `action_required`: The workflow pauses for user action. See `context.action` for details. Stop automated polling until the user completes the required action. * `blocked`: A third party, such as the domain extension’s registry or a losing registrar, prevents progress. Continue polling because the block may resolve when the third party responds. * `succeeded`: Terminal state. The operation completed successfully. `completed` equals `true`. For registrations, `context.registration` contains the resulting registration resource. * `failed`: Terminal state. The operation failed. `completed` equals `true`. See `error.code` and `error.message` for the reason. Require user review before retrying. One of the following: "pending" "in\_progress" "action\_required" "blocked" "succeeded" "failed" updated\_at: string formatdate-time context: optional map\[unknown\] Provides workflow-specific data. For domain-centric workflows, `context.domain_name` identifies the workflow subject. error: optional object { code, message } Provides error details when a workflow reaches the `failed` state. The workflow type (registration, update, etc.) and underlying registry response determine the specific codes and messages. Workflow error codes differ from immediate HTTP error `errors[].code` values in non-2xx responses. Surface `error.message` to the user for context. code: string Machine-readable error code identifying the failure reason. message: string Human-readable explanation of the failure. May include registry-specific details. success: true Whether the API call was successful. ### Create Registration HTTP HTTPHTTP TypeScriptTypeScript PythonPython GoGo TerraformTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/registrar-sandbox/registrations \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \ -d '{ "domain_name": "my-brand-example.io", "acknowledgements": { "fees": "bar" }, "contact_extensions": { "application_purpose": "bar", "nexus_category": "bar" }, "privacy_mode": "redaction", "years": 1 }' ``` 201 example 202 example 4XX example 4XX example 4XX example 4XX example 4XX example ``` { "errors": [], "messages": [], "result": { "completed": true, "context": { "domain_name": "example.com", "registration": { "auto_renew": true, "created_at": "2025-10-27T10:00:00Z", "domain_name": "example.com", "expires_at": "2026-10-27T10:00:00Z", "locked": true, "privacy_mode": "redaction", "status": "active" } }, "created_at": "2025-10-27T10:00:00Z", "links": { "resource": "/accounts/abc/registrar/registrations/example.com", "self": "/accounts/abc/registrar/registrations/example.com/registration-status" }, "state": "succeeded", "updated_at": "2025-10-27T10:00:03Z" }, "success": true } ``` ``` { "errors": [], "messages": [], "result": { "completed": false, "context": { "domain_name": "example.com" }, "created_at": "2025-10-27T10:00:00Z", "links": { "resource": "/accounts/abc/registrar/registrations/example.com", "self": "/accounts/abc/registrar/registrations/example.com/registration-status" }, "state": "in_progress", "updated_at": "2025-10-27T10:00:10Z" }, "success": true } ``` ``` { "errors": [ { "code": 10000, "message": "Domain limit reached: you cannot register more than 500 domains.", "source": { "pointer": "/domain_name" } } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "domain_name is required", "source": { "pointer": "/domain_name" } } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "Must be a boolean", "source": { "pointer": "/auto_renew" } } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "No registrant contact provided and no default address book entry found for this account." } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "Registration is not supported for this extension" } ], "messages": [], "result": null, "success": false } ``` ##### Returns Examples 201 example 202 example 4XX example 4XX example 4XX example 4XX example 4XX example ``` { "errors": [], "messages": [], "result": { "completed": true, "context": { "domain_name": "example.com", "registration": { "auto_renew": true, "created_at": "2025-10-27T10:00:00Z", "domain_name": "example.com", "expires_at": "2026-10-27T10:00:00Z", "locked": true, "privacy_mode": "redaction", "status": "active" } }, "created_at": "2025-10-27T10:00:00Z", "links": { "resource": "/accounts/abc/registrar/registrations/example.com", "self": "/accounts/abc/registrar/registrations/example.com/registration-status" }, "state": "succeeded", "updated_at": "2025-10-27T10:00:03Z" }, "success": true } ``` ``` { "errors": [], "messages": [], "result": { "completed": false, "context": { "domain_name": "example.com" }, "created_at": "2025-10-27T10:00:00Z", "links": { "resource": "/accounts/abc/registrar/registrations/example.com", "self": "/accounts/abc/registrar/registrations/example.com/registration-status" }, "state": "in_progress", "updated_at": "2025-10-27T10:00:10Z" }, "success": true } ``` ``` { "errors": [ { "code": 10000, "message": "Domain limit reached: you cannot register more than 500 domains.", "source": { "pointer": "/domain_name" } } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "domain_name is required", "source": { "pointer": "/domain_name" } } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "Must be a boolean", "source": { "pointer": "/auto_renew" } } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "No registrant contact provided and no default address book entry found for this account." } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 10000, "message": "Registration is not supported for this extension" } ], "messages": [], "result": null, "success": false } ```