Getting Started

Prerequisites

Create an API key per the documentation here.

Your API key is unique to the environment you use, see Selecting your environment below.

Selecting your environment

Subdomains are used to separate the production and sandbox environments. If you would like access to the sandbox, please contact jasanzitsupport@jasanz.org.

Examples in the documentation will always reference the production environment. Please ensure you connect using the correct endpoint for your use case.

Environment	Endpoint	Description

Environment

Endpoint

Description

Production

https://partnerapi.jasanz.org/api/V1/Partner/BulkUploadAPI

See Swagger document:

https://partnerapi.jasanz.org/swagger/index.html

Sandbox

https://partnerapi-dev.jasanz.org/api/V1/Partner/BulkUploadAPI

See Swagger document:

https://partnerapi-dev.jasanz.org/swagger/index.html

Authentication

To authenticate, add the jasanz_api_key header to your API request. Use the key generated from Prerequisites as the value.

Example header:

POST https://partnerapi.jasanz.org/api/V1/Partner/BulkUploadAPI
jasanz_api_key: *key.value.here*

Requests

You must always provide an authentication header as described above.

Formatting your request

When submitting data the payload must always be formatted as JSON.

Simplified JSON example

{
  "certifications": {
    "certification": [
      {
        "id_number": "string",
        "type": "string"
      }
    ]
  }
}

Responses

Response types are outlined below, including a sampling of error types.

Status	Code	Body	Description

Status	Code	Body	Description
Error	500	Key Expired	The API key used to authenticate the call has expired. Renew the key and try again.
Error	500	Please add JASANZ_API_KEY header and value in request.	You have not included the authentication header in your request.
Error	500	Please add audit details in JSON.	The audit details object is missing from the body of the request.
Success	200	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx	A successful POST returns a GUID for the submitted data. This GUID can be referenced through the UI to assess the validation results.

Examples

Creating a Management Systems Certificate with extra scrutiny applied

{
  "certifications": {
    "certification": [
      {
        "id_number": "MGT-0001a",
        "type": "Management Systems",
        "status": "Active",
        "description_of_scope": "Example scope for Org-0001a",
        "original_issue_date": "20181208",
        "current_issue_date": "20211208",
        "expiry_date": "20241207",
        "certificate_holder": "Org-0001a",
        "organisation_trading_as_name": "Bobs Accountancy",
        "organisation_street_address": "28a Foreclosure Lane",
        "organisation_city": "Deakin",
        "organisation_state": "ACT",
        "organisation_country": "Australia",
        "organisation_postcode": "2600",
        "organisation_email": "contact@bobsaccountancy.com.au",
        "product_total_no_of_licences_issued": null,
        "ghg_level_of_assurance": null,
        "ghg_measurement_period": null,
        "isdelete": null,
        "schemelist": {
          "scheme": [
            {
              "scheme_name": "Quality Management Systems Scheme",
              "standardlist": {
                "standard": [
                  {
                    "standard_name": "ISO 9001:2015",
                    "categorisationlist": {
                      "categorisation": []
                    }
                  }
                ]
              }
            }
          ]
        },
        "modellist": {
          "model": []
        },
        "codelist": {
          "code": [
            {
              "id_number": "MGT-0001a",
              "code_value": "64"
            }
          ]
        },
        "sitelist": {
          "site": [
            {
              "id_number": "MGT-0001a",
              "site_street_address": "92 Boundary Street",
              "site_city": "Garbutt",
              "site_state": "QLD",
              "site_country": "Australia",
              "site_postcode": "4814"
            }
          ]
        },
        "auditlist": {
          "audit": [
            {
              "id_number": "MGT-0001a",
              "audit_id": "MGT-0001a-01",
              "certification_decision_maker": "Phil Conker",
              "audited_site": "92 Boundary Street, Garbutt QLD 4814 Australia",
              "date_commenced_on_site": "20211104",
              "date_finished_on_site": "20211106",
              "total_on_site_man_days_for_audit": "2.5",
              "auditteammemberlist": {
                "auditteammember": [
                  {
                    "audit_id": "MGT-0001a-01",
                    "name": "Jackson Coleman",
                    "role": "Lead Auditor"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Creating a Product Certificate with multiple models

{
  "certifications": {
    "certification": [
      {
        "id_number": "PRD-0001c",
        "type": "Product",
        "status": "Suspended",
        "description_of_scope": "JDS-91x Series Routers",
        "original_issue_date": null,
        "current_issue_date": "20220401",
        "expiry_date": "20290331",
        "certificate_holder": "Trusted Telecomms",
        "organisation_trading_as_name": "Avecentis Communications",
        "organisation_street_address": "56a Bairnes St",
        "organisation_city": "Theodore",
        "organisation_state": "ACT",
        "organisation_country": "Australia",
        "organisation_postcode": "2905",
        "organisation_email": "admin@avecentis.com.au",
        "product_total_no_of_licences_issued": "3",
        "ghg_level_of_assurance": null,
        "ghg_measurement_period": null,
        "isdelete": null,
        "schemelist": {
          "scheme": [
            {
              "scheme_name": "JDS Electrical Type Test Scheme",             
               "standardlist": {
                "standard": [
                  {
                    "standard_name": "AS/ACIF S041.1-2015",
                    "categorisationlist": {
                      "categorisation": []
                    }
                  },
                  {
                    "standard_name": "AS/CA S002-2015",
                    "categorisationlist": {
                      "categorisation": []
                  }
                }
              ]
            }
          }
        ]
        },
        "modellist": {
          "model": [
            {
              "model_name": "Avecentis 9100 Series WAN Router",
              "model_number": "JDS-91.1WAN",
              "model_description": "NBN FTTP-Compatible Wireless Router",
              "brand": "Avecentis",
              "manufacturelocationlist": {
                "manufacturelocation": [
                  {
                    "street_address": "10922 Changtai Road",
                    "city": "Nantong",
                    "state": "Jiangsu",
                    "postcode": "226003",
                    "country": "China"
                  }
                ]
              }
            },
            {
              "model_name": "Avecentis 9100 Series DSL Router",
              "model_number": "JDS-91DSL",
              "model_description": "NBN and DSL-Compatible Wireless Router",
              "brand": "Avecentis",
              "manufacturelocationlist": {
                "manufacturelocation": [
                  {
                    "street_address": "STH12A-01 Duong",
                    "city": "Daegu",
                    "state": null,
                    "postcode": "157",
                    "country": "South Korea"
                  }
                ]
              }
            }
          ]
        },
        "codelist": {
          "code": []
        },
        "sitelist": {
          "site": []
        },
        "auditlist": {
          "audit": []
        }
      }
    ]
  }
}

Creating a Validation and Verification Certificate

{
  "certifications": {
    "certification": [
      {
        "id_number": "VV-0002",
        "type": "Validation and Verification",
        "status": "Suspended",
        "description_of_scope": "Example Scope for VV-0002",
        "original_issue_date": "20210211",
        "current_issue_date": "20220211",
        "expiry_date": "20230210",
        "certificate_holder": "Example Org Name",
        "organisation_trading_as_name": "Example Trading Name",
        "organisation_street_address": "Example Street Address",
        "organisation_city": "Example City",
        "organisation_state": "Example State",
        "organisation_country": "New Zealand",
        "organisation_postcode": "1234",
        "organisation_email": "examplemail@org.com",
        "ghg_level_of_assurance": "Unstated",
        "ghg_measurement_period": "February 2021 through March 2021",
        "schemelist": {
          "scheme": [
            {
              "scheme_name": "GHG Verification Scheme",
              "standardlist": {
                "standard": [
                  {
                    "standard_name": "ISO 14064-1:2018",
                    "categorisationlist": {
                      "categorisation": []
                    }
                  }
                ]
              }
            }
          ]
        },
        "codelist": {
          "code": [
            {
              "id_number": "VV-0002",
              "code_value": "70"
            }
          ]
        },
        "sitelist": {
          "site": [
            {
              "id_number": "VV-0002",
              "site_street_address": "22 Fake street",
              "site_city": "Fake City",
              "site_state": "Fake State",
              "site_country": "Australia",
              "site_postcode": "4444"
            }
          ]
        },
        "auditlist": {
          "audit": [
            {
              "id_number": "VV-0002",
              "audit_id": "VV-0002",
              "certification_decision_maker": "VV-0002",
              "audited_site": "VV-0002",
              "date_commenced_on_site": "20220801",
              "date_finished_on_site": "20220802",
              "total_on_site_man_days_for_audit": "4.5",
              "auditteammemberlist": {
                "auditteammember": [
                  {
                    "audit_id": "VV-0002",
                    "name": "VV-0002",
                    "role": "Lead Auditor"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Submitting Multiple Certificates

{
  "certifications": {
    "certification": [
      {
        "id_number": "VV-0002",
        "type": "Validation and Verification",
        "status": "Suspended",
        "description_of_scope": "Example Scope for VV-0002 - Update",
        "original_issue_date": "20210211",
        "current_issue_date": "20220211",
        "expiry_date": "20230210",
        "certificate_holder": "Example Org Name",
        "organisation_trading_as_name": "Example Trading Name",
        "organisation_street_address": "Example Street Address",
        "organisation_city": "Example City",
        "organisation_state": "Example State",
        "organisation_country": "New Zealand",
        "organisation_postcode": "1234",
        "organisation_email": "examplemail@org.com",
        "ghg_level_of_assurance": "Unstated",
        "ghg_measurement_period": "February 2021 through March 2021",
        "schemelist": {
          "scheme": [
            {
              "scheme_name": "GHG Verification Scheme",
              "standardlist": {
                "standard": [
                  {
                    "standard_name": "ISO 14064-1:2018",
                    "categorisationlist": {
                      "categorisation": []
                    }
                  }
                ]
              }
            }
          ]
        },
        "codelist": {
          "code": [
            {
              "id_number": "VV-0002",
              "code_value": "70"
            }
          ]
        },
        "sitelist": {
          "site": [
            {
              "id_number": "VV-0002",
              "site_street_address": "22 Fake street",
              "site_city": "Fake City",
              "site_state": "Fake State",
              "site_country": "Australia",
              "site_postcode": "4444"
            }
          ]
        },
        "auditlist": {
          "audit": [
            {
              "id_number": "VV-0002",
              "audit_id": "VV-0002",
              "certification_decision_maker": "VV-0002",
              "audited_site": "VV-0002",
              "date_commenced_on_site": "20220801",
              "date_finished_on_site": "20220802",
              "total_on_site_man_days_for_audit": "4.5",
              "auditteammemberlist": {
                "auditteammember": [
                  {
                    "audit_id": "VV-0002",
                    "name": "VV-0002",
                    "role": "Lead Auditor"
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "id_number": "PR-0002",
        "type": "Product",
        "status": "Active",
        "description_of_scope": "Example scope for PR-0002",
        "original_issue_date": "20120920",
        "current_issue_date": "20220920",
        "expiry_date": "20250919",
        "certificate_holder": "Example for PR-0002",
        "organisation_trading_as_name": "Example for PR-0002",
        "organisation_street_address": "Example for PR-0002",
        "organisation_city": "Example for PR-0002",
        "organisation_state": "Example for PR-0002",
        "organisation_country": "Australia",
        "organisation_postcode": "9999",
        "organisation_email": "Fake@email.com",
        "product_total_no_of_licences_issued": "12",
        "isdelete": null,
        "schemelist": {
          "scheme": [
            {
              "scheme_name": "Australian Wood Packaging Certification Scheme",
              "standardlist": {
                "standard": [
                  {
                    "standard_name": "AWPCS V3 Appendix 1a",
                    "categorisationlist": {
                      "categorisation": []
                    }
                  },
                  {
                    "standard_name": "AWPCS V3 Appendix 1b",
                    "categorisationlist": {
                      "categorisation": []
                    }
                  }
                ]
                 
              }
            }
          ]
        },
        "modellist": {
          "model": [
            {
              "model_name": "1200x900 ply sheet",
              "model_number": "1200APY",
              "model_description": "Formwork Ply (non-structural)",
              "brand": "TimberMates",
              "manufacturelocationlist": {
                "manufacturelocation": [
                  {
                    "street_address": "44 Treelopper Lane",
                    "city": "Garbutt",
                    "state": "QLD",
                    "postcode": "4814",
                    "country": "Australia"
                  }
                ]
              }
            }
          ]
        },
        "codelist": {
          "code": []
        },
        "sitelist": {
          "site": [
            {
              "id_number": "PR-0002",
              "site_street_address": "22 Fake street",
              "site_city": "Fake City",
              "site_state": "Fake State",
              "site_country": "Australia",
              "site_postcode": "4444"
            }
          ]
        },
        "auditlist": {
          "audit": [
            {
              "id_number": "VV-0002",
              "audit_id": "VV-0002",
              "certification_decision_maker": "VV-0002",
              "audited_site": "VV-0002",
              "date_commenced_on_site": "20220801",
              "date_finished_on_site": "20220802",
              "total_on_site_man_days_for_audit": "1.5",
              "auditteammemberlist": {
                "auditteammember": [
                  {
                    "audit_id": "VV-0002",
                    "name": "VV-0002",
                    "role": "Lead Auditor"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Field Name Glossary

Object	Array	Field Name	UI Equivalent	Value Required?	Comments

Object	Array	Field Name	UI Equivalent	Value Required?	Comments
certifications			N/A	Yes	All certifications to be processed
	certification		N/A	Yes	Core details of the certification are captured here
		id_number	Certificate ID	Yes	The unique ID for the certification
		type	Type	Yes	The type of certification. Allowed values are: Management Systems Product Validation and Verification Personnel
		status	Certificate Status	Yes	The status of the certification. Allowed values are: Active Suspended Withdrawn
		description_of_scope	Description of Scope	Yes	A succinct factual description covering the scope of certification
		original_issue_date	Original Issue Date	No	The earliest date known date of certification (with no breaks), expressed as YYYYMMDD
		current_issue_date	Current Issue Date	Yes	The current date of certification, expressed as YYYYMMDD
		expiry_date	Expiry Date	Yes	The expiry date for certification, expressed as YYYYMMDD
		certificate_holder	Certificate Holder	Yes	The registered business name of the organisation, or the full name of the certified person
		organisation_trading_as_name	Trading Name	No	The trading name of the organisation, if different to the registered business name
		organisation_street_address	Street Address	Yes	The street address of the certificate holder
		organisation_city	City	Yes	The city of the certificate holder
		organisation_state	State	No	The state of the certificate holder
		organisation_country	Country	Yes	The country of the certificate holder
		organisation_postcode	Post Code	Yes	The postcode of the certificate holder
		organisation_email	Email Address	No	A contact email for the certificate holder
		product_total_no_of_licences_issued	Total No. of Licences Issued	No	The total number of licenses issued. Value can only be supplied if type = product, otherwise set to null
		ghg_level_of_assurance	Level of Assurance	Yes	Compulsory if type = validation and verification, otherwise set to null
		ghg_measurement_period	Measurement Period	Yes	Compulsory if type = validation and verification, otherwise set to null
		isdelete	N/A	No	Pass in string with value "Yes" to delete the referenced certificate, otherwise set to null
schemelist			N/A	Yes	All schemes to be processed for the parent certification record
	scheme		N/A	Yes	The individual instance of a scheme
		scheme_name	Scheme(s)	Yes	The name of the certification scheme
standardlist			N/A	Yes	All standards to be processed for the parent scheme record
	standard		N/A	Yes	The individual instance of a standard
		standard_name	Certification Standard(s)	Yes	The name of the certification standard
categorisationlist			Categories tab	No	All categories to be processed for the parent standard record
	categorisation		Categories tab	No	The individual instance of a category.
		category	Category	Yes	The name of the category
		subcategory	Sub-Category	No	The name of the sub-category, if not available set to null.
		technicalsector	Technical Sector	No	The name of the technical sector, if not available set to null.
modellist			Models tab	No	All models to be processed for the parent certification record
	model		Models tab	No	The individual instance of a model
		model_name	Model Name	Yes	The name of the model
		model_number	Model Number	Yes	The unique model number
		model_description	Model Description	Yes	A description of the model
		brand	Brand	Yes	The brand of the model
manufacturelocationlist			Manufacturing Location blade	No	All manufacturing sites to be processed for the parent model record
	manufacturelocation		Manufacturing Location blade	No	The individual instance of a manufacturing location
		street_address	Street Address	Yes	The street address of the manufacturing location

API Documentation