CustomerPhoneResponse

{
    "properties": {
        "phones": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Phone"
            }
        }
    }
}
              

CustomerAddressResponse

{
    "properties": {
        "addressList": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Address"
            }
        }
    }
}
              

Email

{
    "properties": {
        "emailAddress": {
            "description": "Email address of the customer",
            "type": "string",
            "example": "javier123@yahoo.com"
        },
        "emailType": {
            "description": "The type of email.  This is a reference data field. Please use /v1/apac/utilities/referenceData/{emailType} resource to get valid value of this field with description. You can use emailType as the referenceCode parameter to retrieve the values ",
            "type": "string",
            "example": "PERSONAL"
        },
        "preferredEmailFlag": {
            "description": "Flag to indicate the preferred Email.",
            "type": "boolean",
            "example": "true"
        }
    },
    "required": [
        "emailAddress"
    ]
}
              

Address

{
    "properties": {
        "city": {
            "description": "City",
            "type": "string",
            "example": "SINGAPORE"
        },
        "addressType": {
            "description": "Type of the address. This is a reference data field. Please use /v1/apac/utilities/referenceData/{addressType} resource to get valid value of this field with description. You can use addressType as the referenceCode parameter to retrieve the values.",
            "type": "string",
            "example": "PRIMARY_ADDRESS"
        },
        "postalCode": {
            "description": "Postal code the mailing address",
            "type": "string",
            "example": "520189"
        },
        "addressline3": {
            "description": "address line3 of the mailing address",
            "type": "string",
            "example": "Orchard Avenue 2"
        },
        "addressline2": {
            "description": "address line2 of the mailing address",
            "type": "string",
            "example": "#99-99 MACDONALD HOUSE"
        },
        "addressline1": {
            "description": "address line1 of the mailing address",
            "type": "string",
            "example": "40A ORCHARD ROAD"
        },
        "state": {
            "description": "State",
            "type": "string",
            "example": "SINGAPORE"
        },
        "countryName": {
            "description": "Country Name",
            "type": "string",
            "example": "SINGAPORE"
        },
        "addressline4": {
            "description": "address line4 of the mailing address",
            "type": "string",
            "example": "Street 65"
        }
    },
    "required": [
        "addressline1",
        "addressType"
    ]
}
              

Phone

{
    "properties": {
        "phoneType": {
            "description": "The type of phone.  This is a reference data field. Please use /v1/apac/utilities/referenceData/{phoneType} resource to get valid value of this field with description. You can use phoneType as the referenceCode parameter to retrieve the values",
            "type": "string",
            "example": "HOME"
        },
        "areaCode": {
            "description": "Area code of telephone number",
            "type": "string",
            "example": "O"
        },
        "extension": {
            "description": "Extension of telephone number",
            "type": "string",
            "example": "O"
        },
        "phoneNumber": {
            "description": "The phone number of a customer",
            "type": "string",
            "example": "4567234512"
        },
        "phoneCountryCode": {
            "description": "Country code in ISO 3166 format",
            "type": "string",
            "example": "34"
        }
    },
    "required": [
        "phoneType",
        "phoneNumber"
    ]
}
              

CustomerParticulars

{
    "properties": {
        "names": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Name"
            }
        },
        "gender": {
            "description": "Gender/Sex. Valid values are MALE, FEMALE for individual customer types and OTHERS for corporate customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{gender} resource to get valid value of this field with description. You can use gender as the referenceCode parameter to retrieve the values.",
            "type": "string"
        },
        "prefix": {
            "description": "The prefix of the customer s name.",
            "type": "string",
            "example": "Mr."
        },
        "suffix": {
            "description": "The suffix of the customer s name.",
            "type": "string",
            "example": "III"
        }
    }
}
              

CustomerEmailResponse

{
    "properties": {
        "emails": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Email"
            }
        }
    }
}
              

CustomerParticularResponse

{
    "properties": {
        "customerType": {
            "description": "Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerType} resource to get valid value of this field with description. You can use customerType as the referenceCode parameter to retrieve the values.",
            "type": "string",
            "example": "INDIVIDUAL"
        },
        "customerParticulars": {
            "$ref": "#/definitions/CustomerParticulars"
        },
        "customerSegment": {
            "description": "Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerSegment} resource to get valid value of this field with description. You can use customerSegment as the referenceCode parameter to retrieve the values.",
            "type": "string",
            "example": "BLUE"
        }
    },
    "required": [
        "customerSegment"
    ]
}
              

CustomerProfileResponse

{
    "properties": {
        "emails": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Email"
            }
        },
        "customerType": {
            "description": "Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerType} resource to get valid value of this field with description. You can use customerType as the referenceCode parameter to retrieve the values.",
            "type": "string",
            "example": "INDIVIDUAL"
        },
        "customerParticulars": {
            "$ref": "#/definitions/CustomerParticulars"
        },
        "customerSegment": {
            "description": "Type of the customer. This is applicable only for Individual customers.This is a reference data field. Please use /v1/apac/utilities/referenceData/{customerSegment} resource to get valid value of this field with description. You can use customerSegment as the referenceCode parameter to retrieve the values.",
            "type": "string",
            "example": "BLUE"
        },
        "addressList": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Address"
            }
        },
        "phones": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Phone"
            }
        }
    },
    "required": [
        "customerSegment"
    ]
}
              

ErrorResponse

{
    "properties": {
        "code": {
            "description": "Error code which qualifies the error",
            "type": "string"
        },
        "details": {
            "description": "Human readable explanation specific to the occurrence of the problem",
            "type": "string"
        },
        "location": {
            "description": "The name of the field that resulted in the error",
            "type": "string"
        },
        "type": {
            "description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
            "type": "string",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "moreInfo": {
            "description": "URI to human readable documentation of the error",
            "type": "object"
        }
    },
    "required": [
        "type",
        "code"
    ]
}
              

Name

{
    "properties": {
        "nameType": {
            "description": "Type of the name. This is a reference data field. Please use /v1/apac/utilities/referenceData/{nameType} resource to get valid value of this field with description. You can use nameType as the referenceCode parameter to retrieve the values.",
            "type": "string",
            "example": "LOCAL_NAME"
        },
        "firstName": {
            "description": "The first name of the customer. Also known as first name",
            "type": "string",
            "example": "Javier"
        },
        "lastName": {
            "description": "The last name of the customer. Also known as last name",
            "type": "string",
            "example": "de Cuellar"
        },
        "fullName": {
            "description": "Full name of the customer.",
            "type": "string",
            "example": "Javier Perez de Cuellar"
        },
        "middleName": {
            "description": "Middle name of the customer.",
            "type": "string",
            "example": "Perez"
        }
    },
    "required": [
        "firstName"
    ]
}