Project

Set the company or personal details

A phone number is registered to a business or a person. For a business, set the company name, the address with its country, a contact person and the number in its country's business register (kvk_number in the Netherlands, registration_number elsewhere) before you order a number. Without a company, send account_type personal with the user's address and the user as contact: no registration number needed. A national number needs a business; a personal account can order a geographic number. In test mode no registration or VAT number is needed to order a test number. Switching to account_type personal is refused while the project has a national number (account_type_change_blocked); every switch resets the number_documents and full verification levels to not_started. In the EU send vat_number: we check it with VIES before saving (vat_number_invalid when VIES says it is not valid; vat_status unverified when VIES does not respond, and we retry). A country we cannot serve returns country_not_supported. Which numbers you can order is what GET /numbers/available returns. PUT replaces all fields, except registrar_contact_name, which keeps its saved value when left out. When the project has domains registered or transferred through Hypamoon, the contact, email, phone and address also go to each domain's contact at the registry; domain_contacts in the response says per domain updated, unchanged, skipped or failed, with the reason. A change of organization, registration number or (personal account) person is a change of holder: never sent automatically, it needs Hypamoon support.

put/project/company

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/project/company
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: project:write)

Request body

account_type'personal' | 'business'

personal (someone without a company: no company_name, kvk_number, registration_number or vat_number) or business. Leave it out to keep the project's current type. A national number needs business. When a personal account is not available for the address, validation_failed says so.

company_namestring nullable

The legal name. Required for a business, not allowed for a personal account.

kvk_numberstring nullable

For a company in the Netherlands (required there): the KvK number, 8 digits. Spaces and dots are removed.

registration_numberstring nullable

For a company outside the Netherlands: the number in its country's business register (like a UK Companies House number or a German HRB number). Needed for the company verification level outside the EU.

vat_numberstring nullable

The VAT number. In the EU outside the Netherlands it is needed for the company verification level and checked with VIES: send it with or without the country prefix. A number that VIES rejects returns vat_number_invalid.

registrar_contact_namestring nullable

Optional, for a business: the name on the contacts of the domains registered or transferred through Hypamoon, when it should differ from contact.name. Use a role, like Administration or Webmaster, so the domain registration carries no personal name while contact.name stays the person that number registration needs. Leave it out to keep the saved value; send null to use contact.name again. Not allowed for a personal account.

Response

The company details as saved.

account_type'personal' | 'business' required

personal (your own details, no business register number) or business.

company_namestring nullable required

The legal company name; null for a personal account.

kvk_numberstring nullable required

8 digits, for a company in the Netherlands; null elsewhere.

registration_numberstring nullable required

The number in the business register of the company's country, for a company outside the Netherlands (there it is kvk_number).

vat_numberstring nullable required

The VAT number, with country prefix in the EU (like DE123456789).

vat_status'valid' | 'invalid' | 'unverified' | 'missing' | 'not_required' required

For a company in the EU: the VIES check of vat_number (unverified when VIES did not answer; we retry automatically). missing: no VAT number yet. not_required: no VIES check needed for this country.

vat_checked_atstring nullable required

When VIES last checked vat_number, ISO 8601.

registrar_contact_namestring nullable

Only for a business: the name on the domain contacts at the registry when it differs from contact.name, or null (then contact.name is used).

completeboolean required

The details are complete enough for the company or personal verification level: a business needs its business register number and, in the EU, a valid VAT number; a personal account needs a complete address.

Changes

No recorded changes to this operation across all 1 revision of this API.