Get Customer
Describes the Get Customer call.
Purposeβ
The purpose of this endpoint is to deliver information about a specific Principal using the principalId and return the customer information whether they be an individual (Person) or a company etc (Organisation).
This Data Adapter endpoint is used to deliver the responses for the following Consumer Data Standards endpoints:
Data Adapter APIβ
Get Customerβ
Loading...
Β
Within the OpenAPI specification a deprecated endpoint path at /banking/customer/{'principalId'} exists with an otherwise exact contract. This path was the original path for Get Customer and has been deprecated.
Β
Consumer Data Standards Associationsβ
Get Customerβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Expected Error | 400 | urn:au-cds:error:cds-all:GeneralError/Expected | This status code indicates that the Expected Error has encountered. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Internal Server Error | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected | This status code indicates that the server encountered an internal error or misconfiguration. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
Get Customer Detailβ
Loading...
CDR Error Mappingβ
| Title | Status Code | Adapter URN - Error Code | Detail | CDR Status Code | CDR URN - Error Code |
|---|---|---|---|---|---|
| Expected Error | 400 | urn:au-cds:error:cds-all:GeneralError/Expected | This status code indicates that the Expected Error has encountered. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Invalid Resource | 404 | urn:au-cds:error:cds-all:Resource/Invalid | The requested resource identifier is permanently unavailable. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
| Legal Block | 451 | urn:dio:error:cds-all:Resource/LegalBlock | This status code indicates that the server is denying access to the resource as a consequence of a legal demand. | 422 | urn:au-cds:error:cds-all:Resource/Unavailable |
| Ineligible Block | 451 | urn:dio:error:cds-all:Resource/IneligibleBlock | This status code indicates that the Customer is ineligible for CDR Data Sharing. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Call Center Block | 451 | urn:dio:error:cds-all:Resource/CallCenterBlock | This status code indicates that the consumer should call the Call Center for further information. | 422 | urn:au-cds:error:cds-all:Resource/Invalid |
| Internal Server Error | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected | This status code indicates that the server encountered an internal error or misconfiguration. | 500 | urn:au-cds:error:cds-all:GeneralError/Unexpected |
Β
Supplemental Fieldsβ
Beyond attributes which map one-to-one between Data Adapter and Consumer Data Standards fields the following are identified as additional fields specifically with relation to the successful operation of the HaaS environment:
| Name | Description |
|---|---|
agentFirstName | The first name of the individual providing access on behalf of the organisation. For people with single names this field need not be present. The single name should be in the lastName field Note: Deprecated and replaced by Get User |
agentLastName | The last name of the individual providing access on behalf of the organisation. For people with single names the single name should be in this field Note: Deprecated and replaced by Get User |
agentRole | The role of the individual identified as the agent who is providing authorisation. Expected to be used for display. Default to Unspecified if the role is not known. Note: Deprecated and replaced by Get User |
Endpoint Specific Guidanceβ
- The HaaS Platform assumes that ANZSIC Industry Codes in use are
ANZSIC_1292.0_2006_V2.0. - Refer to specific notice regarding
/banking/customer/{'principalId'}.