Identity

The Identity API returns the information about a customer.

Identity Endpoints

get/v1/common/identity

The Identity model

Retrieves an identity object.

Attributes

Expand all
customer
objectoptional

Customer contains customer identity from the most recent consent for the provided end user ID. This field is deprecated and will be removed in the future.

Show child attributes
identities
arrayrequired

Identities contains all the customer identities for the provided end user ID

Show child attributes
Response
{
    "customer": {
        "arrangement_id": "f41bb11b-0bdf-4b7c-9e24-a0d6cad0b3e6",
        "customer": {
            "customer_u_type": "person",
            "organisation": {
                "abn": "12345678901",
                "acn": "987654321",
                "agent_first_name": "John",
                "agent_last_name": "Doe",
                "agent_role": "Manager",
                "business_name": "Tech Corp",
                "establishment_date": "2010-01-01",
                "industry_code": "5420",
                "industry_code_version": "ANZSIC_1292.0_2006_V2.0",
                "is_acnc_registered": true,
                "last_update_time": "2023-08-15T10:30:00Z",
                "legal_name": "Tech Solutions Ltd",
                "organisation_type": "COMPANY",
                "physical_addresses": [
                    {
                        "address_u_type": "paf",
                        "paf": {
                            "building_name_1": "Castle",
                            "building_name_2": "string",
                            "dpid": "34567890",
                            "flat_unit_number": "12B",
                            "flat_unit_type": "U",
                            "floor_level_number": "7",
                            "floor_level_type": "FL",
                            "locality_name": "SYDNEY",
                            "lot_number": "42",
                            "postal_delivery_number": 2,
                            "postal_delivery_number_prefix": "N",
                            "postal_delivery_number_suffix": "A",
                            "postal_delivery_type": "PO BOX",
                            "postcode": "2000",
                            "state": "NSW",
                            "street_name": "WALLABY",
                            "street_suffix": "S",
                            "street_type": "WAY",
                            "thoroughfare_number1": 40,
                            "thoroughfare_number1_suffix": "A",
                            "thoroughfare_number2": 44,
                            "thoroughfare_number2_suffix": "A"
                        },
                        "purpose": "REGISTERED",
                        "simple": {
                            "address_line1": "42 Wallaby Way",
                            "address_line2": "string",
                            "address_line3": "string",
                            "city": "SYDNEY",
                            "country": "AUS",
                            "mailing_name": "Shiny Dental",
                            "postcode": "2000",
                            "state": "NSW"
                        }
                    }
                ],
                "registered_country": "AUS",
                "short_name": "TechCo"
            },
            "person": {
                "email_addresses": [
                    {
                        "address": "jane.doe@example.com",
                        "is_preferred": true,
                        "purpose": "WORK"
                    }
                ],
                "first_name": "Jane",
                "last_name": "Doe",
                "last_update_time": "2023-08-10T09:00:00Z",
                "middle_names": [],
                "occupation_code": "2613",
                "occupation_code_version": "ANZSCO_1220.0_2013_V1.2",
                "phone_numbers": [
                    {
                        "area_code": "2",
                        "country_code": "+61",
                        "extension": "1234",
                        "full_number": "+61 2 9876 5432",
                        "is_preferred": true,
                        "number": "98765432",
                        "purpose": "MOBILE"
                    }
                ],
                "physical_addresses": [
                    {
                        "address_u_type": "paf",
                        "paf": {
                            "building_name_1": "Castle",
                            "building_name_2": "string",
                            "dpid": "34567890",
                            "flat_unit_number": "12B",
                            "flat_unit_type": "U",
                            "floor_level_number": "7",
                            "floor_level_type": "FL",
                            "locality_name": "SYDNEY",
                            "lot_number": "42",
                            "postal_delivery_number": 2,
                            "postal_delivery_number_prefix": "N",
                            "postal_delivery_number_suffix": "A",
                            "postal_delivery_type": "PO BOX",
                            "postcode": "2000",
                            "state": "NSW",
                            "street_name": "WALLABY",
                            "street_suffix": "S",
                            "street_type": "WAY",
                            "thoroughfare_number1": 40,
                            "thoroughfare_number1_suffix": "A",
                            "thoroughfare_number2": 44,
                            "thoroughfare_number2_suffix": "A"
                        },
                        "purpose": "REGISTERED",
                        "simple": {
                            "address_line1": "42 Wallaby Way",
                            "address_line2": "string",
                            "address_line3": "string",
                            "city": "SYDNEY",
                            "country": "AUS",
                            "mailing_name": "Shiny Dental",
                            "postcode": "2000",
                            "state": "NSW"
                        }
                    }
                ],
                "prefix": "Ms",
                "suffix": "Jr"
            }
        },
        "fiskil_id": "abcdef1234xyz",
        "institution_id": "140"
    },
    "identities": [
        {
            "arrangement_id": "f41bb11b-0bdf-4b7c-9e24-a0d6cad0b3e6",
            "customer": {
                "customer_u_type": "person",
                "organisation": {
                    "abn": "12345678901",
                    "acn": "987654321",
                    "agent_first_name": "John",
                    "agent_last_name": "Doe",
                    "agent_role": "Manager",
                    "business_name": "Tech Corp",
                    "establishment_date": "2010-01-01",
                    "industry_code": "5420",
                    "industry_code_version": "ANZSIC_1292.0_2006_V2.0",
                    "is_acnc_registered": true,
                    "last_update_time": "2023-08-15T10:30:00Z",
                    "legal_name": "Tech Solutions Ltd",
                    "organisation_type": "COMPANY",
                    "physical_addresses": [
                        {
                            "address_u_type": "paf",
                            "paf": {
                                "building_name_1": "Castle",
                                "building_name_2": "string",
                                "dpid": "34567890",
                                "flat_unit_number": "12B",
                                "flat_unit_type": "U",
                                "floor_level_number": "7",
                                "floor_level_type": "FL",
                                "locality_name": "SYDNEY",
                                "lot_number": "42",
                                "postal_delivery_number": 2,
                                "postal_delivery_number_prefix": "N",
                                "postal_delivery_number_suffix": "A",
                                "postal_delivery_type": "PO BOX",
                                "postcode": "2000",
                                "state": "NSW",
                                "street_name": "WALLABY",
                                "street_suffix": "S",
                                "street_type": "WAY",
                                "thoroughfare_number1": 40,
                                "thoroughfare_number1_suffix": "A",
                                "thoroughfare_number2": 44,
                                "thoroughfare_number2_suffix": "A"
                            },
                            "purpose": "REGISTERED",
                            "simple": {
                                "address_line1": "42 Wallaby Way",
                                "address_line2": "string",
                                "address_line3": "string",
                                "city": "SYDNEY",
                                "country": "AUS",
                                "mailing_name": "Shiny Dental",
                                "postcode": "2000",
                                "state": "NSW"
                            }
                        }
                    ],
                    "registered_country": "AUS",
                    "short_name": "TechCo"
                },
                "person": {
                    "email_addresses": [
                        {
                            "address": "jane.doe@example.com",
                            "is_preferred": true,
                            "purpose": "WORK"
                        }
                    ],
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "last_update_time": "2023-08-10T09:00:00Z",
                    "middle_names": [],
                    "occupation_code": "2613",
                    "occupation_code_version": "ANZSCO_1220.0_2013_V1.2",
                    "phone_numbers": [
                        {
                            "area_code": "2",
                            "country_code": "+61",
                            "extension": "1234",
                            "full_number": "+61 2 9876 5432",
                            "is_preferred": true,
                            "number": "98765432",
                            "purpose": "MOBILE"
                        }
                    ],
                    "physical_addresses": [
                        {
                            "address_u_type": "paf",
                            "paf": {
                                "building_name_1": "Castle",
                                "building_name_2": "string",
                                "dpid": "34567890",
                                "flat_unit_number": "12B",
                                "flat_unit_type": "U",
                                "floor_level_number": "7",
                                "floor_level_type": "FL",
                                "locality_name": "SYDNEY",
                                "lot_number": "42",
                                "postal_delivery_number": 2,
                                "postal_delivery_number_prefix": "N",
                                "postal_delivery_number_suffix": "A",
                                "postal_delivery_type": "PO BOX",
                                "postcode": "2000",
                                "state": "NSW",
                                "street_name": "WALLABY",
                                "street_suffix": "S",
                                "street_type": "WAY",
                                "thoroughfare_number1": 40,
                                "thoroughfare_number1_suffix": "A",
                                "thoroughfare_number2": 44,
                                "thoroughfare_number2_suffix": "A"
                            },
                            "purpose": "REGISTERED",
                            "simple": {
                                "address_line1": "42 Wallaby Way",
                                "address_line2": "string",
                                "address_line3": "string",
                                "city": "SYDNEY",
                                "country": "AUS",
                                "mailing_name": "Shiny Dental",
                                "postcode": "2000",
                                "state": "NSW"
                            }
                        }
                    ],
                    "prefix": "Ms",
                    "suffix": "Jr"
                }
            },
            "fiskil_id": "abcdef1234xyz",
            "institution_id": "140"
        }
    ]
}
GET

/v1/common/identity

Retrieve Customer

Returns information for the specified end_user_id

Parameters

end_user_idstringrequired

A unique identifier for the End User object.

institution_idstring

A unique identifier for the Institution object.

Request
GET/v1/common/identity
curl --request GET \
     --url https://api.fiskil.com/v1/v1/common/identity?end_user_id={end_user_id}&institution_id={institution_id} \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8' 
Response
{
    "customer": {
        "arrangement_id": "f41bb11b-0bdf-4b7c-9e24-a0d6cad0b3e6",
        "customer": {
            "customer_u_type": "person",
            "organisation": {
                "abn": "12345678901",
                "acn": "987654321",
                "agent_first_name": "John",
                "agent_last_name": "Doe",
                "agent_role": "Manager",
                "business_name": "Tech Corp",
                "establishment_date": "2010-01-01",
                "industry_code": "5420",
                "industry_code_version": "ANZSIC_1292.0_2006_V2.0",
                "is_acnc_registered": true,
                "last_update_time": "2023-08-15T10:30:00Z",
                "legal_name": "Tech Solutions Ltd",
                "organisation_type": "COMPANY",
                "physical_addresses": [
                    {
                        "address_u_type": "paf",
                        "paf": {
                            "building_name_1": "Castle",
                            "building_name_2": "string",
                            "dpid": "34567890",
                            "flat_unit_number": "12B",
                            "flat_unit_type": "U",
                            "floor_level_number": "7",
                            "floor_level_type": "FL",
                            "locality_name": "SYDNEY",
                            "lot_number": "42",
                            "postal_delivery_number": 2,
                            "postal_delivery_number_prefix": "N",
                            "postal_delivery_number_suffix": "A",
                            "postal_delivery_type": "PO BOX",
                            "postcode": "2000",
                            "state": "NSW",
                            "street_name": "WALLABY",
                            "street_suffix": "S",
                            "street_type": "WAY",
                            "thoroughfare_number1": 40,
                            "thoroughfare_number1_suffix": "A",
                            "thoroughfare_number2": 44,
                            "thoroughfare_number2_suffix": "A"
                        },
                        "purpose": "REGISTERED",
                        "simple": {
                            "address_line1": "42 Wallaby Way",
                            "address_line2": "string",
                            "address_line3": "string",
                            "city": "SYDNEY",
                            "country": "AUS",
                            "mailing_name": "Shiny Dental",
                            "postcode": "2000",
                            "state": "NSW"
                        }
                    }
                ],
                "registered_country": "AUS",
                "short_name": "TechCo"
            },
            "person": {
                "email_addresses": [
                    {
                        "address": "jane.doe@example.com",
                        "is_preferred": true,
                        "purpose": "WORK"
                    }
                ],
                "first_name": "Jane",
                "last_name": "Doe",
                "last_update_time": "2023-08-10T09:00:00Z",
                "middle_names": [],
                "occupation_code": "2613",
                "occupation_code_version": "ANZSCO_1220.0_2013_V1.2",
                "phone_numbers": [
                    {
                        "area_code": "2",
                        "country_code": "+61",
                        "extension": "1234",
                        "full_number": "+61 2 9876 5432",
                        "is_preferred": true,
                        "number": "98765432",
                        "purpose": "MOBILE"
                    }
                ],
                "physical_addresses": [
                    {
                        "address_u_type": "paf",
                        "paf": {
                            "building_name_1": "Castle",
                            "building_name_2": "string",
                            "dpid": "34567890",
                            "flat_unit_number": "12B",
                            "flat_unit_type": "U",
                            "floor_level_number": "7",
                            "floor_level_type": "FL",
                            "locality_name": "SYDNEY",
                            "lot_number": "42",
                            "postal_delivery_number": 2,
                            "postal_delivery_number_prefix": "N",
                            "postal_delivery_number_suffix": "A",
                            "postal_delivery_type": "PO BOX",
                            "postcode": "2000",
                            "state": "NSW",
                            "street_name": "WALLABY",
                            "street_suffix": "S",
                            "street_type": "WAY",
                            "thoroughfare_number1": 40,
                            "thoroughfare_number1_suffix": "A",
                            "thoroughfare_number2": 44,
                            "thoroughfare_number2_suffix": "A"
                        },
                        "purpose": "REGISTERED",
                        "simple": {
                            "address_line1": "42 Wallaby Way",
                            "address_line2": "string",
                            "address_line3": "string",
                            "city": "SYDNEY",
                            "country": "AUS",
                            "mailing_name": "Shiny Dental",
                            "postcode": "2000",
                            "state": "NSW"
                        }
                    }
                ],
                "prefix": "Ms",
                "suffix": "Jr"
            }
        },
        "fiskil_id": "abcdef1234xyz",
        "institution_id": "140"
    },
    "identities": [
        {
            "arrangement_id": "f41bb11b-0bdf-4b7c-9e24-a0d6cad0b3e6",
            "customer": {
                "customer_u_type": "person",
                "organisation": {
                    "abn": "12345678901",
                    "acn": "987654321",
                    "agent_first_name": "John",
                    "agent_last_name": "Doe",
                    "agent_role": "Manager",
                    "business_name": "Tech Corp",
                    "establishment_date": "2010-01-01",
                    "industry_code": "5420",
                    "industry_code_version": "ANZSIC_1292.0_2006_V2.0",
                    "is_acnc_registered": true,
                    "last_update_time": "2023-08-15T10:30:00Z",
                    "legal_name": "Tech Solutions Ltd",
                    "organisation_type": "COMPANY",
                    "physical_addresses": [
                        {
                            "address_u_type": "paf",
                            "paf": {
                                "building_name_1": "Castle",
                                "building_name_2": "string",
                                "dpid": "34567890",
                                "flat_unit_number": "12B",
                                "flat_unit_type": "U",
                                "floor_level_number": "7",
                                "floor_level_type": "FL",
                                "locality_name": "SYDNEY",
                                "lot_number": "42",
                                "postal_delivery_number": 2,
                                "postal_delivery_number_prefix": "N",
                                "postal_delivery_number_suffix": "A",
                                "postal_delivery_type": "PO BOX",
                                "postcode": "2000",
                                "state": "NSW",
                                "street_name": "WALLABY",
                                "street_suffix": "S",
                                "street_type": "WAY",
                                "thoroughfare_number1": 40,
                                "thoroughfare_number1_suffix": "A",
                                "thoroughfare_number2": 44,
                                "thoroughfare_number2_suffix": "A"
                            },
                            "purpose": "REGISTERED",
                            "simple": {
                                "address_line1": "42 Wallaby Way",
                                "address_line2": "string",
                                "address_line3": "string",
                                "city": "SYDNEY",
                                "country": "AUS",
                                "mailing_name": "Shiny Dental",
                                "postcode": "2000",
                                "state": "NSW"
                            }
                        }
                    ],
                    "registered_country": "AUS",
                    "short_name": "TechCo"
                },
                "person": {
                    "email_addresses": [
                        {
                            "address": "jane.doe@example.com",
                            "is_preferred": true,
                            "purpose": "WORK"
                        }
                    ],
                    "first_name": "Jane",
                    "last_name": "Doe",
                    "last_update_time": "2023-08-10T09:00:00Z",
                    "middle_names": [],
                    "occupation_code": "2613",
                    "occupation_code_version": "ANZSCO_1220.0_2013_V1.2",
                    "phone_numbers": [
                        {
                            "area_code": "2",
                            "country_code": "+61",
                            "extension": "1234",
                            "full_number": "+61 2 9876 5432",
                            "is_preferred": true,
                            "number": "98765432",
                            "purpose": "MOBILE"
                        }
                    ],
                    "physical_addresses": [
                        {
                            "address_u_type": "paf",
                            "paf": {
                                "building_name_1": "Castle",
                                "building_name_2": "string",
                                "dpid": "34567890",
                                "flat_unit_number": "12B",
                                "flat_unit_type": "U",
                                "floor_level_number": "7",
                                "floor_level_type": "FL",
                                "locality_name": "SYDNEY",
                                "lot_number": "42",
                                "postal_delivery_number": 2,
                                "postal_delivery_number_prefix": "N",
                                "postal_delivery_number_suffix": "A",
                                "postal_delivery_type": "PO BOX",
                                "postcode": "2000",
                                "state": "NSW",
                                "street_name": "WALLABY",
                                "street_suffix": "S",
                                "street_type": "WAY",
                                "thoroughfare_number1": 40,
                                "thoroughfare_number1_suffix": "A",
                                "thoroughfare_number2": 44,
                                "thoroughfare_number2_suffix": "A"
                            },
                            "purpose": "REGISTERED",
                            "simple": {
                                "address_line1": "42 Wallaby Way",
                                "address_line2": "string",
                                "address_line3": "string",
                                "city": "SYDNEY",
                                "country": "AUS",
                                "mailing_name": "Shiny Dental",
                                "postcode": "2000",
                                "state": "NSW"
                            }
                        }
                    ],
                    "prefix": "Ms",
                    "suffix": "Jr"
                }
            },
            "fiskil_id": "abcdef1234xyz",
            "institution_id": "140"
        }
    ]
}

Was this page helpful?