Skip to content
English - New Zealand
Sign in
Contact us
  • There are no suggestions because the search field is empty.

VerifyBiz API Design Phase checklist

It's almost time to start Building, but before you 'up tools' we want to ensure you're well-prepared.

To kick off the Build phase, please share the following documentation. This allows us to confirm you’re meeting the Terms & Conditions and helps us plan the right support for you as you progress:

✅  A final plan that demonstrates full scope and points of integration, including:

  • Overarching goals and objectives
  • Identifying all systems requiring integration
  • Documenting data flows, APIs, and message formats
  • Testing and validating integration plans
  • Go-live and post-launch monitoring

✅  A mock-up of your UX/UI design for the result notifications which follow the standards within the GetVerified NZ CoP UX / UI Guide, including:

  • Each notification must use consistent iconology including colour as specified in the guide i.e. green tick for Match, red exclamation mark for Not a match etc.
  • Each notification design must use the bold headings as specified in the guide.
  • Each notification unbolded messaging can be edited to align with their own brand voice and UX journey as well as convey the messaging statements in accordance with the advice given against each outcome in the guide.

✅  Your timeline for Building and Testing

  • A delivery plan that takes into account the time it will take for you team to fully build and test the solution.

✅  A change management plan underway

  • An understanding of any training or communications support you need from us.

When you have this collated, please share this information by emailing it to us at support@getverified.co.nz. We aim to come back to you with confirmation or feedback within 48 hours.

If you need further support in developing any of the above, please get in touch and let us know how we can help.

When designing, it's important to consider end-user functionality such as:

  • Paste in field functionality: We recommend that Users can easily paste account names and account numbers into relevant fields.
  • Automatic format validation: For New Zealand–domiciled bank accounts, the system should automatically check for correct formatting:

    2 digits for the bank code
    4 digits for the branch code
    7 digits for the account number
    2–3 digits for the suffix

These small but impactful details help ensure better accuracy and efficiency alongside the Confirmation of Payee tool.