| Insert excerpt | |||||||
|---|---|---|---|---|---|---|---|
|
Companies can be registered with greenID via Web Services in a similar manner to individuals.
...
| Name | Type | Required? | Description | Contact |
|---|---|---|---|---|
| customerId | String | Yes | This parameter is GreenID's identifier for the client application. The value is supplied by GreenID, and must be included with each registration request. | Must be a valid identifier issued by GreenID. |
| password | String | Yes | ||
| clientId | String | Yes | An identifier for the company being registered, supplied by the customer, i.e. it is your identifier for the company being registered, not GreenID's. | No restrictions. |
| ruleId | String | Yes | Specifies the predefined verification rule that this registration will be run against. By default, every customer has at least the rule named "default". | Must be a string and must match a predefined rule string specified in the system. The default rule is named "default". |
| clientType | String | Yes | ||
| abn | String | Yes | The ABN of the company being registered. | No restrictions. All spaces will be stripped prior to being stored. All non-digits are stripped prior to being used for verification purposes. |
| acn | String | Yes | The ACN of the company being registered. | No restrictions. All spaces will be stripped prior to being stored. All non-digits are stripped prior to being used for verification purposes. |
| companyName | String | Yes | The name of the company being registered. | Must be a string that is the valid legal name of the company or business entity being registered. |
| state | String | Yes | The state in which the company is registered. | Must be one of:
|
| postcode | String | Yes | The postcode compent of the company's address. | Must be a string comprising only four digits, i.e.: ^[\d]{4}$ |
| String | Yes | The primay email contact for the company being registered. | Standard Hibernate validation is used. | |
| phone | String | Yes | The primary phone contact for the company being registered. | No restrictions, although non-digits are stripped when used for verification checks. Please don't include country codes. |
| fax | String | No | The primary fax contact number for the company being registered. | Same as for phone numbers. |
| extraData | NameValuePair[] | No | This parameter allows the customer to send extra data that will need to be agreed upon before implementation. It will be a simple key/value format. If there is no previous agreement for certain keys to be send in this field, then it will be ignored. |
...
| Name | Type | Required? | Description | Contact |
|---|---|---|---|---|
| customerId | String | YesY | This parameter is GreenID's identifier for the client application. The value is supplied by GreenID, and must be included with each registration request. | Must be a valid identifier issued by GreenID. |
| password | String | Yes | ||
| clientId | String | Yes | An identifier for the company being registered, supplied by the customer, i.e. it is your identifier for the company being registered, not GreenID's. | No restrictions. |
| ruleId | String | Yes | Specifies the predefined verification rule that this registration will be run against. By default, every customer has at least the rule named "default". | Must be a string and must match a predefined rule string specified in the system. The default rule is named "default". |
| clientType | String | Yes | ||
| abn | String | Yes | The ABN of the company being registered. | No restrictions. All spaces will be stripped prior to being stored. All non-digits are stripped prior to being used for verification purposes. |
| acn | String | Yes | The ACN of the company being registered. | No restrictions. All spaces will be stripped prior to being stored. All non-digits are stripped prior to being used for verification purposes. |
| companyName | String | Yes | The name of the company being registered. | Must be a string that is the valid legal name of the company or business entity being registered. |
| address | SimpleAddress | Yes | ||
| String | Yes | The primay email contact for the company being registered. | Standard Hibernate validation is used. | |
| phone | String | Yes | The primary phone contact for the company being registered. | No restrictions, although non-digits are stripped when used for verification checks. Please don't include country codes. |
| fax | String | No | The primary fax contact number for the company being registered. | Same as for phone numbers. |
| extraData | NameValuePair[] | No | This parameter allows the customer to send extra thata that will need to be agreed upon before implementation. It will be a simple key/value format. If there is no previous agreement for certain keys to be send in this field, then it will be ignored. |
...