Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Companies can be registered with GreenID via Web Services in a similar manner to individulsindividuals.

 

Security Options

Unlike the individual registration Web Service methods, the company registration Web Service methods only use Password authenticationuse Password authentication.

WSDL Locations

The test environment WSDLs for the company registration methods described below are at the following locations:

...

https://www.edentiti.com/Registrations-Registrations/CompanyVerificationServicesPassword?wsdl 

Methods

There are two methods that can be used to register a company with GreenID:

...

public RichVerificationResult registerCompany (
 String customerId,
     String password,
     String clientId,
     String ruleId,
     String clientType,
     String abn,
     String acn,
     String companyName,
     String state,
     String postcode,
     String email,
     String phone,
     String fax,
     NameValuePair[] extraData)

Parameters

NameType
Required?
Description
Contact
customerIdStringYesThis 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.
passwordStringYes  
clientIdStringYesAn 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.
ruleIdStringYesSpecifies 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".
clientTypeStringYes  
abnStringYesThe 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.
acnStringYesThe 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.
companyNameStringYesThe name of the company being registered.Must be a string that is the valid legal name of the company or business entity being registered.
stateStringYesThe state in which the company is registered.Must be one of:
  • ACT
  • NSW
  • NT
  • QLD
  • SA
  • TAS
  • VIC
  • WA
postcodeStringYesThe postcode compent of the company's address.Must be a string comprising only four digits, i.e.:
^[\d]{4}$
emailStringYesThe primay email contact for the company being registered.Standard Hibernate validation is used.
phoneStringYesThe 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.
faxStringNoThe primary fax contact number for the company being registered.Same as for phone numbers.
extraDataNameValuePair[]NoThis parameter allowc 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. 

 

The registerCompanySimpleAddress Method

...

 

Method Signature

Code Block
public RichVerificationResult registerCompany

...

 (
 String customerId,
     String password,
     String clientId,
     String ruleId,
     String clientType,
     String abn,
     String acn,
     String companyName,
     SimpleAddress address,
     String email,
     String phone,
     String fax,
     NameValuePair[] extraData)

 

Parameters

NameType
Required?
Description
Contact
customerIdStringYesYThis 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.
passwordStringYes  
clientIdStringYesAn 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.
ruleIdStringYesSpecifies 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".
clientTypeStringYes  
abnStringYesThe 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.
acnStringYesThe 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.
companyNameStringYesThe name of the company being registered.Must be a string that is the valid legal name of the company or business entity being registered.
addressSimpleAddressYes  
emailStringYesThe primay email contact for the company being registered.Standard Hibernate validation is used.
phoneStringYesThe 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.
faxStringNoThe primary fax contact number for the company being registered.Same as for phone numbers.
extraDataNameValuePair[]NoThis 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. 

 

The SimpleAddress Type

NameType
Required?
Description
Contact
descriptionStringNoA description of the address.Length <= 255 characters.
address1StringYesLine 1 of an address.Length <= 255 characters.
address2StringNoLine 2 of an addressLength <= 255 characters.
address3StringnoLine 3 of an addressLength <= 255 characters.
address4StringNoLine 4 of an addressLength <= 255 characters.
suburbStringYesSuburb component of the address.Length <= 255 characters.
postcodeStringYesPostcode component of the address.Must be a string comprising only four digits, i.e.:
^[\d]{4}$
stateStringYesState component of the address.Must be one of:
  • ACT
  • NSW
  • NT
  • QLD
  • SA
  • TAS
  • VIC
  • WA
countryStringYesCountry component of the address. 

 

Return Value

The return values of the functions are both the same: both methods will return a RichVerificationResult object.  This object is described in deail detail in the section on Outcome Notification, so the reader is referred to that sectio formore section for more detail.  In summary, the return value will indicate the current status cof of the company's registration, and the outcome of any checks that were performed automatically.

...