GetDriver

Allows you to extract details for a driver.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to System Roles and select the 'web_services' role. Navigate to the Roles / APIs tab. Find the Drivers:Get permission and check its checkbox.

Note: Authenticate with the API before running this method. Please refer to the authentication documentation for login information.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.catch-e.com/fm/drivers/{driver_id}

Parameters - Path Variables

Response Details

Successful Response Example

The response returns comprehensive driver details including personal information, employment details, addresses, financial information, and system metadata:

{ "accountant_contact_name": "", "accountant_contact_phone": "", "accountant_firm_name": "", "address_id_home": "100381", "address_id_post": "100380", "addresses": { "home": { "address_1": "", "address_2": "", "area": "", "state": "", "postcode": "", "country_id": null }, "post": { "address_1": "", "address_2": "", "area": "", "state": "", "postcode": "", "country_id": null } }, "allowances": 0, "annual_salary": 0, "asset_bank_accounts": null, "asset_bank_accounts_description": "", "asset_furniture": null, "asset_furniture_description": "", "asset_investment_properties": null, "asset_investment_properties_description": "", "asset_motor_vehicle": null, "asset_motor_vehicle_description": "", "asset_other_investments": null, "asset_other_investments_description": "", "asset_resident_property": null, "asset_resident_property_description": "", "asset_shares": null, "asset_shares_description": "", "asset_super": null, "asset_super_description": "", "ato_loan_flag": "no", "australian_resident": "yes", "card_account_number": "", "client_cost_centre_id": null, "client_id": "100209", "contact_note": "", "corporate_type_id_previous_employer": "0", "created": "2018-04-16 03:22:59", "credit_check_authorised_flag": "", "date_of_birth": "0000-00-00", "driver_claims_flag": "yes", "driver_employment_type_id": "0", "driver_id": "101140", "driver_id_external": "0", "driver_lic_exp": "", "driver_licence": "", "driver_licence_state": "", "driver_licence_class": "", "driver_occupation_code_id": "0", "employee_alias": "", "employee_area": "", "employee_end": "0000-00-00", "employee_group": "", "employee_no": "", "employee_pay_office": "", "employee_sl_acc": "", "employee_start": "0000-00-00", "employee_super": 0, "employer_address_1": "", "employer_address_2": "", "employer_address_3": "", "employer_address_postcode": "", "employer_address_state": "", "employer_super": 0, "expense_credit_card": null, "expense_household": null, "expense_mortgage": null, "expense_other": null, "expense_private_education_childcare": null, "expense_rent": null, "expense_vehicle": null, "external_code": "", "fbt_type": "", "financier_applicant_reference": "", "gender": "", "generated_password": "LAPORTAL", "given_name": "Kylie", "home_car_postcode": "", "home_email": "demo@catch-e.com.au", "home_fax": "", "home_phone": "", "home_postcode": "", "home_state": "", "home_street": "", "home_street_no": "", "home_street_type": "", "home_suburb": "", "home_unit_no": "", "income_government_benefits": null, "income_gross": null, "income_investment": null, "income_net": null, "income_other": null, "income_rental_net": null, "income_spouse_gross": null, "income_spouse_net": null, "income_superannuation": null, "insurance_broker_fee_exempt_flag": "yes", "kyc_verified_flag": "no", "landlord_name": "", "landlord_telephone": "", "last_edit": "2018-04-30 23:36:19", "liability_credit_card_limit": null, "liability_credit_card_limit_description": "", "liability_investment_mortgages": null, "liability_investment_mortgages_description": "", "liability_loans": null, "liability_loans_description": "", "liability_mortgages": null, "liability_mortgages_description": "", "liability_other": null, "liability_other_description": "", "liability_overdraft": null, "liability_overdraft_description": "", "liability_rent": null, "liability_rent_description": "", "marital_status": "", "middle_name": "", "mobile": "", "name_on_account": "", "no_of_dependents": 0, "pay_cycle_id": "0", "preferred_name": "", "previous_address_1": "", "previous_address_2": "", "previous_address_3": "", "previous_address_country_id": null, "previous_address_postcode": "", "previous_address_state": "", "previous_address_years_at_address": 0, "previous_employer_name": "", "previous_employer_phone": "", "previous_years_employed": 0, "report_delivery_type": "email", "residency_status": "", "residential_status": "", "salutation": "", "start_at_address": "0000-00-00", "stop_becs_flag": "no", "supplier_id_etag": "0", "supplier_id_financier": "0", "surname": "Lower", "tag_account_number": "", "tag_number": "", "user_id_assigned": null, "user_id_create": null, "user_id_edit": "10824", "user_id_package_advisor": "0", "work_contact_given": "", "work_contact_position": "", "work_contact_surname": "", "work_fax": "", "work_name": "", "work_phone": "", "work_phone_ext": "", "work_position": "", "work_postcode": "", "work_state": "", "work_street": "", "work_street_no": "", "work_street_type": "", "work_suburb": "", "work_type": "", "work_unit_no": "", "years_at_address": 0, "years_with_employer": 0, "_links": { "self": { "href": "https://api.catch-e.com/fm/drivers/101140" } } } 

Error Response Examples

400 Bad Request

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "JSON decoding error: Syntax error, malformed JSON" } 

The JSON payload content is not formatted correctly.

401 Unauthorized

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" } 

You have not authenticated before running this API or the token_timeout of the current session has passed. You need to authenticate again.

403 Forbidden

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" } 

You do not have permissions for this request. Go to System Roles and enter 'web_services'. Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

422 Failed Validation

{ "validation_messages": { "driver_id": { "noRecordFound": "No record matching the input was found" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" } 

Invalid driver ID provided.

Data Fields Available

The response includes comprehensive driver data organised in the following categories:

• Personal information (name, contact, date of birth, etc.)

• Address details (home and postal addresses)

• Employment information (employer, position, employment dates)

• Financial data (salary, superannuation, income sources)

• Assets (vehicles, properties, investments, superannuation)

• Liabilities (mortgages, loans, credit cards)

• Driver licence information

• System metadata (created date, last edited, user IDs)