Domain object mapping retrieval endpoint.
GET/v1/admin/mapping/:type/:arkId
Required User Role: ADMIN
This endpoint retrieves information about a domain object instance in the Ark platform along with the associated mapping against external system identifier via the configured connector. It accepts path values to identify the type and identifier of the desired domain object instance.
The domain object types supported by this endpoint are:
- Customer
- Account
- Card
In the instance of a customer domain object, the following data values are returned:
| Value Name | Description |
|---|---|
| Customer number | Externally presented customer number. Some core systems use differing formats for customer numbers. This is the number presented to the customer. |
| DPID | Delivery point identifier (DPID) - a unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. |
| Verification ID | The unique identifier for the customer verification process. This is used to link the customer instance to the verification process. |
In the instance of an account domain object, the following data values are returned:
- Account number - externally presented account number used for transfers, etc
- Bank State Branch (BSB) code
- Product key - the type of the account (e.g. TRANSACTION, SAVINGS)
- Product version - the version of the product (e.g. 1.0.0)
In the instance of a card domain object, the following data values are returned:
- Card type - the type of the card (e.g. PHYSICAL, VIRTUAL, PHYSICAL_AND_VIRTUAL)
- Ark account ID - the Ark identifier for the account instance to associate the card with. The account instance must exist in the Ark platform before the card instance is created.
Request
Responses
- 200
- 400
- 401
- 404
- 500
The requested domain object mapping was retrieved successfully.
Schema validation failed (GEN000000)
Invalid API key (GEN001004)
Resource not found (GEN004001)
Internal server error (GEN100000) or Service error (GEN100001)