Versions Compared

Key

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

...

 

Name

Type

Required?

Description 

customerId

 

 

String

255 Chars

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.

 

 

userId

 

 

String

255 Chars

Yes

 

This parameter is an identifier that the client uses for the individual being verified. GreenID does not use it as an identifier, but in order to easily locate individual's for a particular client application, the userIdis used. This must match a registered userId

 

Return Value

PostOfficeData 

The complex type PostOfficeData has the structure described below.  

This type and the following members are for the most part exact representations of the fields found in an Australia Post contract. The reader should be aware of the individual Australia Post contract they will be using to ensure that they can match up the fields. These fields are retrieved from a flat file and stored in Strings with no interpretation of the meanings of the fields. Not all implementations of an Australia Post contract will have all the fields detailed below.

...

Member

...

Type

...

Description

...

Contract

...

customerId

 

...

String

255 Chars

...

This parameter is GreenID's identifier for the client application. The value is supplied by GreenID.

 

...

Not null.

 

...

documents

...

String

...

Human readable string that is a comma separated list of all the names of the documents used to verify this user.

...

Not null.

...

header

...

detailRecordHeader

...

Representation of the header of the flat file received from Australia Post

...

Not null.

...

poFileName

 

...

String

255 Chars

...

The name of the actual file read from Australia Post

 

...

Not null.

 

...

records

...

documentRecord[]

...

List of individual representations of the documents used to verify this User

...

DetailRecordHeader 

The complex type DetailRecordHeader has the structure described below:  

...