contact_create

Used to create a new contact.

Inputs Description Type Regular expression Mandatory
is_individual Contact type Values : individual = 1; company = 0. Boolean Oui
firstname Prénom String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150} Oui
lastname Nom String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150} Oui
orgname The company name String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150} Si le champ is_individual = 0
street Address field String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,250} Oui
street2 Address field String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,250} Non
city Ville String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150} Oui
pc Zip code String [ a-zA-Z0-9._#/-]{1,30} Oui
sp State String [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]//^_`|}{]{0,80} Non
cc Country code String [A-Za-z]{2} Oui
voice Phone number String \+[0-9]{1,3}\.[0-9]{1,15} Oui
fax Fax String \+[0-9]{1,3}\.[0-9]{1,15} Non
email Email address String [0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,7}) Oui
password String (min 5, max 15) Oui
birthday Date Non
place_of_birth String (for .fr domains : zipcode, city) Non
number type= »S » N° SIREN String [0-9]{9} Non
number type= »M » N° marque String [0-9]{9} Non
Intracom N° TVA intracommunautaire String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,50} Non

 

Inputs * (.FR ONLY) Description Type Regular expression Mandatory
duns Data Universal Numbering System String [0-9]{9} Non
localnumber N° identifiant local String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,50} Non
assowaldec N° identifiant association String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,50} Non
assocreationdate Creation date association Date Non
assodeclarationdate Declaration date prefecture Date Non
assopubannounce Official N° announce newspaper short Non
assopubpage Official N° page newspaper short Non

 
* A .FR Domain can only be registered by any European. citizen or resident, as well as any business or organizations.
One of the following eligibility requirements must be met:
A natural person
1. who is a citizen or permanent resident European (birthday, place_of_birth)
Any entity or organization that is
1. Incorporated within European country
(Business: N° SIREN ou N°Marque ou N° TVA intracommunautaire ou N° duns ou N° localnumber)
(Organizations: N° assowaldec ou [assocreationdate et assodeclarationdate et assopubannounce et assopubpage])

Inputs * (.US ONLY) Type of use Value to submit Type
nexus_purpose Commercial
Organization
Personal use
Education
Government
P1
P2
P3
P4
P5
String(2)
String(2)
String(2)
String(2)
String(2)
nexus_cat Permanent resident in USA C12 String(3)
You’re not American, but you have business relations with USA C32 String(3)
You’re not American, but you have an office in the USA C31 String(3)

 
* A .US Domain can only be registered by any U.S. citizen or resident, as well as any business or organization, including federal, state, and local government with a bona fide presence in the United States.
One of the following eligibility requirements must be met:
A natural person
1. who is a citizen or permanent resident of the United States of America or any of its possessions or territories
or
2. whose primary place of domicile is in the United States of America or any of its possessions, or
Any entity or organization that is
1. incorporated within one of the fifty (50) U.S. states, the District of Columbia, or any of the United States possessions or territories
or
2. organized or otherwise constituted under the laws of a state of the United States of America, the District of Columbia, or any of its possessions or territories, or
An entity or organization (including federal, state, or local government of the United States, or a political subdivision thereof) that has a bona fide presence in the United States.

Inputs * (.IT ONLY) Description Type Regular expression Mandatory
intracom VAT number String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,50} If company
passport Passport number String If individual
identitycard Identity number String If individual

 
* A domain name. It can’t be registered as European citizens.
One of the following eligibility requirements must be met:
A natural person
1. Have an ID number or passport number
Any entity or organization
2. Have a VAT number

Inputs * (.PT ONLY) Description Type Expression régulière Obligatoire
intracom VAT number String [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,50} If company and number not filled
number type= »S » SIREN number String [0-9]{9} If company and intracom not filled
number type= »M » Brand number String [0-9]{9} If company and intracom not filled

 
One of the following eligibility requirements must be met:
Any entity or organization
1. Have a VAT number
2. Have a SIREN number (ou company registration number) or a Brand number

Outputs Description Possible values
contact_id The contact identifier of the created contact

 

Error code

Error code Parameter Message Value comment
501 is_individual command syntax error The ‘is_individual’ element has an invalid value according to its data type Possible values: particulier = 1; organisation = 0.
501 firstname command syntax error The ‘firstname’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150}
501 lastname command syntax error The ‘lastname’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150}
501 orgname command syntax error The ‘orgname’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150}
501 street command syntax error The ‘street’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,250}
501 street2 command syntax error The ‘street2’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,250}
501 city command syntax error The ‘city’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.!#$%'()*+,:;=\-?@[\]//^_`|}{]{1,150}
501 pc command syntax error The ‘pc’ element has an invalid value according to its data type Possible values: [ a-zA-Z0-9._#/-]{1,30}
501 sp command syntax error The ‘sp’ element has an invalid value according to its data type Possible values: [A-Za-z0-9 \.\-!#$%'()*+,:;=?@[\]//^_`|}{]{0,80}
501 cc command syntax error The ‘cc’ element has an invalid value according to its data type Possible values: [A-Za-z]{2}
501 cc Sémantique error The ‘cc’ element has an invalid semantique value Valeur inconnue
501 voice command syntax error The ‘voice’ element has an invalid value according to its data type Possible values:String (format: code téléphone pays + «.» + numéro de téléphone)format international ISO (par exemple +33.103139811)\+[0-9]{1,3}\.[0-9]{1,15}
501 fax command syntax error The ‘fax’ element has an invalid value according to its data type Possible values:String (format: code téléphone pays + «.» + numéro de fax)\+[0-9]{1,3}\.[0-9]{1,15}
501 email command syntax error The ’email’ element has an invalid value according to its data type Possible values:format défini par le RFC2822[0-9a-zA-Z_\.-]+@(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z][A-Z0-9a-z-]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,7})
501 password command syntax error The ‘password’ element has an invalid value according to its data type Possible values:String (min 5, max 15)
501 birthday command syntax error The ‘birthday’ element has an invalid value according to its data type Possible values: Date
501 place_of_birth command syntax error The ‘place_of_birth’ element has an invalid value according to its data type Possible values : String: If FR : postalcode, cityElse : country code (BE, DE, …)
501 number type= »S » command syntax error The ‘number’ element has an invalid value according to its data type Possible values: N° SIREN
540 orgname parameter value error Required parameter missing (orgName: range(1-100) The OrgName is mandatory when is_individual = 0
550 place_of_birth parameter value policy error FR is not allowed, you should specify postal code and city
550 place_of_birth parameter value policy error Invalid Place of Birth, should be BE or 75, paris or 75008, paris
550 cc parameter value policy error Invalid code country
550 pc, city (cc) parameter value policy error Postal code does not match the city In the contact country, the postal code doesn’t match the city

 

Command

<api>
[…]
<command>
<contact_create>
<is_individual>…</is_individual>
<firstname>…</firstname>
<lastname>…</lastname>
<street>…</street>
<city>…</city>
<pc>…</pc>
<voice>…</voice>
<email>…</email>
<password>…</password>
If is_individual = 1
<birthday>…</birthday>
<place_of_birth>…</place_of_birth>
If is_individual = 0
<number type="S">…</number>
</contact_create>
</command>
</api>

Response

<?xml version="1.0" encoding="utf-8"?>
<api>
<response>
<trID>…</trID>
<result code="…">
<msg>…</msg>
</result>
</response>
<resData>
<contact_creData>
<contact_id>…</contact_id>
</contact_creData>
</resData>
</api>