Contacts

Download schema

There are up to three different types of contacts for a domain: Owner: The owner is the registrant and owner of the domain. Administrative: The administrative contact of a domain is typically in charge of performing all domain-related actions. Technical: The technical contact of a domain takes care of technical issues like DNS records.

It is possible to be the Owner and the Administrative and / or the Technical contact all at once but some registries may have specific requirements.

Check if contacts are compatible with a domain or a TLD

POST

https://api.scaleway.com

/domain/v2beta1/check-contacts-compatibility

Check whether contacts are compatible with a domain or a TLD. If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned.

Check if contacts are compatible with a domain or a TLD › Request Body

domains

string[]

tlds

string[]

owner_contact_id

string | null

administrative_contact_id

string | null

technical_contact_id

string | null

Check if contacts are compatible with a domain or a TLD › Responses

200

scaleway.domain.v2beta1.CheckContactsCompatibilityResponse

compatible

boolean

scaleway.domain.v2beta1.CheckContactsCompatibilityResponse.ContactCheckResult

POST/domain/v2beta1/check-contacts-compatibility

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/domain/v2beta1/check-contacts-compatibility"

Example Request Body

{
  "domains": [
    "string"
  ],
  "tlds": [
    "string"
  ],
  "owner_contact_id": "owner_contact_id",
  "owner_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "administrative_contact_id": "administrative_contact_id",
  "administrative_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  },
  "technical_contact_id": "technical_contact_id",
  "technical_contact": {
    "legal_form": "legal_form_unknown",
    "firstname": "firstname",
    "lastname": "lastname",
    "company_name": "company_name",
    "email": "email",
    "email_alt": "email_alt",
    "phone_number": "phone_number",
    "fax_number": "fax_number",
    "address_line_1": "address_line_1",
    "address_line_2": "address_line_2",
    "zip": "zip",
    "city": "city",
    "country": "country",
    "vat_identification_code": "vat_identification_code",
    "company_identification_code": "company_identification_code",
    "lang": "unknown_language_code",
    "resale": true,
    "extension_fr": {
      "mode": "mode_unknown",
      "individual_info": {
        "whois_opt_in": true
      },
      "duns_info": {
        "duns_id": "duns_id",
        "local_id": "local_id"
      },
      "association_info": {
        "publication_jo": "2022-03-22T12:34:56.123456Z",
        "publication_jo_page": 0
      },
      "trademark_info": {
        "trademark_inpi": "trademark_inpi"
      },
      "code_auth_afnic_info": {
        "code_auth_afnic": "code_auth_afnic"
      }
    },
    "extension_eu": {
      "european_citizenship": "european_citizenship"
    },
    "whois_opt_in": true,
    "state": "state",
    "extension_nl": {
      "legal_form": "legal_form_unknown",
      "legal_form_registration_number": "legal_form_registration_number"
    },
    "extension_it": {
      "european_citizenship": "european_citizenship",
      "tax_code": "tax_code",
      "pin": "pin"
    },
    "questions": [
      {
        "question": "question",
        "answer": "answer"
      }
    ]
  }
}

json

Example Responses

{
  "compatible": true,
  "owner_check_result": {
    "compatible": true,
    "error_message": "error_message"
  },
  "administrative_check_result": {
    "compatible": true,
    "error_message": "error_message"
  },
  "technical_check_result": {
    "compatible": true,
    "error_message": "error_message"
  }
}

json

application/json

List contacts

GET

https://api.scaleway.com

/domain/v2beta1/contacts

Retrieve the list of contacts and their associated domains and roles. You can filter the list by domain name.

List contacts › query Parameters

page

google.protobuf.Int32Value · int32

page_size

integer · uint32

domain

google.protobuf.StringValue

project_id

google.protobuf.StringValue

organization_id

google.protobuf.StringValue

role

scaleway.domain.v2beta1.ListContactsRequest.Role · enum

Enum values:

unknown_role

owner

administrative

technical

Default: unknown_role

email_status

scaleway.domain.v2beta1.Contact.EmailStatus · enum

Enum values:

email_status_unknown

validated

not_validated

invalid_email

Default: email_status_unknown

List contacts › Responses

200

scaleway.domain.v2beta1.ListContactsResponse

total_count

integer · uint32

scaleway.domain.v2beta1.ContactRoles[]

GET/domain/v2beta1/contacts

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/domain/v2beta1/contacts"

Example Responses

{
  "total_count": 0,
  "contacts": [
    {
      "contact": {
        "id": "id",
        "legal_form": "legal_form_unknown",
        "firstname": "firstname",
        "lastname": "lastname",
        "company_name": "company_name",
        "email": "email",
        "email_alt": "email_alt",
        "phone_number": "phone_number",
        "fax_number": "fax_number",
        "address_line_1": "address_line_1",
        "address_line_2": "address_line_2",
        "zip": "zip",
        "city": "city",
        "country": "country",
        "vat_identification_code": "vat_identification_code",
        "company_identification_code": "company_identification_code",
        "lang": "unknown_language_code",
        "resale": true,
        "extension_fr": {
          "mode": "mode_unknown",
          "individual_info": {
            "whois_opt_in": true
          },
          "duns_info": {
            "duns_id": "duns_id",
            "local_id": "local_id"
          },
          "association_info": {
            "publication_jo": "2022-03-22T12:34:56.123456Z",
            "publication_jo_page": 0
          },
          "trademark_info": {
            "trademark_inpi": "trademark_inpi"
          },
          "code_auth_afnic_info": {
            "code_auth_afnic": "code_auth_afnic"
          }
        },
        "extension_eu": {
          "european_citizenship": "european_citizenship"
        },
        "whois_opt_in": true,
        "email_status": "email_status_unknown",
        "state": "state",
        "extension_nl": {
          "legal_form": "legal_form_unknown",
          "legal_form_registration_number": "legal_form_registration_number"
        },
        "status": "status_unknown",
        "extension_it": {
          "european_citizenship": "european_citizenship",
          "tax_code": "tax_code",
          "pin": "pin"
        },
        "questions": [
          {
            "question": "question",
            "answer": "answer"
          }
        ]
      },
      "roles": {
        "<roleKey>": {
          "is_owner": true,
          "is_administrative": true,
          "is_technical": true
        }
      }
    }
  ]
}

json

application/json

Get a contact

GET

https://api.scaleway.com

/domain/v2beta1/contacts/{contact_id}

Retrieve a contact's details from the registrar using the given contact's ID.

Get a contact › path Parameters

contact_id

string · required

Get a contact › Responses

200

scaleway.domain.v2beta1.Contact

id

string

legal_form

scaleway.domain.v2beta1.Contact.LegalForm · enum

Enum values:

legal_form_unknown

individual

corporate

association

other

Default: legal_form_unknown

firstname

string

lastname

string

company_name

string

email

string

email_alt

string

phone_number

string

fax_number

string

address_line_1

string

address_line_2

string

zip

string

city

string

country

string

vat_identification_code

string

company_identification_code

string

lang

scaleway.std.LanguageCode · enum

Enum values:

unknown_language_code

en_US

fr_FR

de_DE

Default: unknown_language_code

resale

boolean

scaleway.domain.v2beta1.Contact.ExtensionFR

scaleway.domain.v2beta1.Contact.ExtensionEU

whois_opt_in

boolean

email_status

scaleway.domain.v2beta1.Contact.EmailStatus · enum

Enum values:

email_status_unknown

validated

not_validated

invalid_email

Default: email_status_unknown

state

string

scaleway.domain.v2beta1.Contact.ExtensionNL

status

scaleway.domain.v2beta1.Contact.Status · enum

Enum values:

status_unknown

active

pending

Default: status_unknown

scaleway.domain.v2beta1.Contact.ExtensionIT

GET/domain/v2beta1/contacts/{contact_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/domain/v2beta1/contacts/{contact_id}"

Example Responses

{
  "id": "id",
  "legal_form": "legal_form_unknown",
  "firstname": "firstname",
  "lastname": "lastname",
  "company_name": "company_name",
  "email": "email",
  "email_alt": "email_alt",
  "phone_number": "phone_number",
  "fax_number": "fax_number",
  "address_line_1": "address_line_1",
  "address_line_2": "address_line_2",
  "zip": "zip",
  "city": "city",
  "country": "country",
  "vat_identification_code": "vat_identification_code",
  "company_identification_code": "company_identification_code",
  "lang": "unknown_language_code",
  "resale": true,
  "extension_fr": {
    "mode": "mode_unknown",
    "individual_info": {
      "whois_opt_in": true
    },
    "duns_info": {
      "duns_id": "duns_id",
      "local_id": "local_id"
    },
    "association_info": {
      "publication_jo": "2022-03-22T12:34:56.123456Z",
      "publication_jo_page": 0
    },
    "trademark_info": {
      "trademark_inpi": "trademark_inpi"
    },
    "code_auth_afnic_info": {
      "code_auth_afnic": "code_auth_afnic"
    }
  },
  "extension_eu": {
    "european_citizenship": "european_citizenship"
  },
  "whois_opt_in": true,
  "email_status": "email_status_unknown",
  "state": "state",
  "extension_nl": {
    "legal_form": "legal_form_unknown",
    "legal_form_registration_number": "legal_form_registration_number"
  },
  "status": "status_unknown",
  "extension_it": {
    "european_citizenship": "european_citizenship",
    "tax_code": "tax_code",
    "pin": "pin"
  },
  "questions": [
    {
      "question": "question",
      "answer": "answer"
    }
  ]
}

json

application/json

Update contact

PATCH

https://api.scaleway.com

/domain/v2beta1/contacts/{contact_id}

Edit the contact's information.

Update contact › path Parameters

contact_id

string · required

Update contact › Request Body

email

google.protobuf.StringValue

email_alt

google.protobuf.StringValue

phone_number

google.protobuf.StringValue

fax_number

google.protobuf.StringValue

address_line_1

google.protobuf.StringValue

address_line_2

google.protobuf.StringValue

zip

google.protobuf.StringValue

city

google.protobuf.StringValue

country

google.protobuf.StringValue

vat_identification_code

google.protobuf.StringValue

company_identification_code

google.protobuf.StringValue

lang

scaleway.std.LanguageCode · enum

Enum values:

unknown_language_code

en_US

fr_FR

de_DE

Default: unknown_language_code

resale

google.protobuf.BoolValue

scaleway.domain.v2beta1.Contact.ExtensionFR

scaleway.domain.v2beta1.Contact.ExtensionEU

scaleway.domain.v2beta1.Contact.ExtensionNL

scaleway.domain.v2beta1.Contact.ExtensionIT

whois_opt_in

google.protobuf.BoolValue

state

google.protobuf.StringValue

Update contact › Responses

200

scaleway.domain.v2beta1.Contact

id

string

legal_form

scaleway.domain.v2beta1.Contact.LegalForm · enum

Enum values:

legal_form_unknown

individual

corporate

association

other

Default: legal_form_unknown

firstname

string

lastname

string

company_name

string

email

string

email_alt

string

phone_number

string

fax_number

string

address_line_1

string

address_line_2

string

zip

string

city

string

country

string

vat_identification_code

string

company_identification_code

string

lang

scaleway.std.LanguageCode · enum

Enum values:

unknown_language_code

en_US

fr_FR

de_DE

Default: unknown_language_code

resale

boolean

scaleway.domain.v2beta1.Contact.ExtensionFR

scaleway.domain.v2beta1.Contact.ExtensionEU

whois_opt_in

boolean

email_status

scaleway.domain.v2beta1.Contact.EmailStatus · enum

Enum values:

email_status_unknown

validated

not_validated

invalid_email

Default: email_status_unknown

state

string

scaleway.domain.v2beta1.Contact.ExtensionNL

status

scaleway.domain.v2beta1.Contact.Status · enum

Enum values:

status_unknown

active

pending

Default: status_unknown

scaleway.domain.v2beta1.Contact.ExtensionIT

PATCH/domain/v2beta1/contacts/{contact_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/domain/v2beta1/contacts/{contact_id}"

Example Request Body

{
  "email": "email",
  "email_alt": "email_alt",
  "phone_number": "phone_number",
  "fax_number": "fax_number",
  "address_line_1": "address_line_1",
  "address_line_2": "address_line_2",
  "zip": "zip",
  "city": "city",
  "country": "country",
  "vat_identification_code": "vat_identification_code",
  "company_identification_code": "company_identification_code",
  "lang": "unknown_language_code",
  "resale": true,
  "extension_fr": {
    "mode": "mode_unknown",
    "individual_info": {
      "whois_opt_in": true
    },
    "duns_info": {
      "duns_id": "duns_id",
      "local_id": "local_id"
    },
    "association_info": {
      "publication_jo": "2022-03-22T12:34:56.123456Z",
      "publication_jo_page": 0
    },
    "trademark_info": {
      "trademark_inpi": "trademark_inpi"
    },
    "code_auth_afnic_info": {
      "code_auth_afnic": "code_auth_afnic"
    }
  },
  "extension_eu": {
    "european_citizenship": "european_citizenship"
  },
  "extension_nl": {
    "legal_form": "legal_form_unknown",
    "legal_form_registration_number": "legal_form_registration_number"
  },
  "extension_it": {
    "european_citizenship": "european_citizenship",
    "tax_code": "tax_code",
    "pin": "pin"
  },
  "whois_opt_in": true,
  "state": "state",
  "questions": [
    {
      "question": "question",
      "answer": "answer"
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "legal_form": "legal_form_unknown",
  "firstname": "firstname",
  "lastname": "lastname",
  "company_name": "company_name",
  "email": "email",
  "email_alt": "email_alt",
  "phone_number": "phone_number",
  "fax_number": "fax_number",
  "address_line_1": "address_line_1",
  "address_line_2": "address_line_2",
  "zip": "zip",
  "city": "city",
  "country": "country",
  "vat_identification_code": "vat_identification_code",
  "company_identification_code": "company_identification_code",
  "lang": "unknown_language_code",
  "resale": true,
  "extension_fr": {
    "mode": "mode_unknown",
    "individual_info": {
      "whois_opt_in": true
    },
    "duns_info": {
      "duns_id": "duns_id",
      "local_id": "local_id"
    },
    "association_info": {
      "publication_jo": "2022-03-22T12:34:56.123456Z",
      "publication_jo_page": 0
    },
    "trademark_info": {
      "trademark_inpi": "trademark_inpi"
    },
    "code_auth_afnic_info": {
      "code_auth_afnic": "code_auth_afnic"
    }
  },
  "extension_eu": {
    "european_citizenship": "european_citizenship"
  },
  "whois_opt_in": true,
  "email_status": "email_status_unknown",
  "state": "state",
  "extension_nl": {
    "legal_form": "legal_form_unknown",
    "legal_form_registration_number": "legal_form_registration_number"
  },
  "status": "status_unknown",
  "extension_it": {
    "european_citizenship": "european_citizenship",
    "tax_code": "tax_code",
    "pin": "pin"
  },
  "questions": [
    {
      "question": "question",
      "answer": "answer"
    }
  ]
}

json

application/json

Imports / Exports Order