Skip to main content
POST

​
Employees v2 — MVR Verification

The endpoints below are identical to their v1 equivalents above, except they automatically trigger MVR (Member Verification) for the employee once a fund identity is known. Calling a v2 endpoint is the opt-in — there is no separate flag, and your existing v1 integration is completely unaffected if you don’t use them. See the MVR Verification page for what this means for payment eligibility.

​
Employee Data Stored

The following static information is stored:
  • Name (first name, last name)
  • Gender
  • Date of birth
  • Address
  • Email
  • Tax File Number (TFN)
  • Superannuation identifiers (USI, memberNumber, employmentPayrollNumber)
  • Optional employee ABN (if applicable)
The employee is automatically associated with the authenticated client’s context. USI, memberNumber, and employmentPayrollNumber are required for onboarding and are later reused when building Superannuation clearing house validation and submission payloads.

​
Use Case

  • Onboard a new employee using this endpoint
  • Store the returned employee ID
  • MVR verification runs automatically in the background — check mvrStatus on the response, or on a later GET /v1/employees/:id call, to see when it resolves
  • Use the employee ID when submitting contributions

​
Request Body

​
string
required
Employee email address (must be valid email format). Must be unique per client - a client cannot have two employees with the same email address.
​
object
required
Employee name
​
string (NOT_STATED, MALE, FEMALE, INDETERMINATE)
required
Employee gender. Valid values: NOT_STATED, MALE, FEMALE, INDETERMINATE
​
object
required
Date of birth. The member must be at least 18 years old. Day must be between 1 and 31.
​
object
required
Employee address
​
string
required
Tax File Number (TFN). Must be unique per client - no two employees under the same client can share a TFN.
​
string
required
Unique Superannuation Identifier (USI) for the employee’s chosen super fund/product. This will be used when building validation and submission payloads to Superannuation clearing house, and is what triggers MVR verification once set.
​
string
required
Member number issued by the superannuation fund for this employee. This will be sent in the Superannuation clearing house member payload and used by the fund to directly match contributions to the member’s account. Must be a string; cannot be blank or whitespace-only. Only alphanumeric characters, hyphens, underscores, and spaces are allowed — no other special characters. Must be unique per client - no two employees under the same client can share a member number.
​
string
required
Employment / payroll number used by the employer to identify this employee in payroll systems. This will be sent as the employmentPayrollNumber field to Superannuation clearing house. Must be unique per client. If omitted, one is auto-generated and guaranteed unique.
​
string
Australian Business Number (ABN) for the employee (typically contractors). Stored for reference only and not sent to Superannuation clearing house APIs. Must be exactly 11 digits, numeric characters only, first digit cannot be zero. Can be presented with or without spaces (e.g., ‘34623710896’ or ‘34 623 710 896’). Must be unique per client - no two employees under the same client can share an ABN.

​
Responses

​
Response fields

​
string
Employee ID
​
string
Client ID that this employee belongs to
​
string
Employee email address (optional)
​
object
Employee name
​
string
Employee gender. Valid values: NOT_STATED, MALE, FEMALE, INDETERMINATE
​
object
Date of birth. The member must be at least 18 years old. Day must be between 1 and 31.
​
object
Employee address
​
string
Tax File Number (TFN)
​
string
Unique Superannuation Identifier (USI) for the employee’s chosen super fund/product. Used when building validation and submission payloads to Superannuation clearing house.
​
string
Member number issued by the superannuation fund for this employee. Sent in the Superannuation clearing house member payload to help the fund match contributions. Must be a string; cannot be blank or whitespace-only. Only alphanumeric characters, hyphens, underscores, and spaces are allowed — no other special characters.
​
string
Employment / payroll number used by the employer to identify this employee in payroll systems. Passed through as employmentPayrollNumber to Superannuation clearing house.
​
string
Australian Business Number (ABN) for the employee (typically contractors). Stored for reference only and not sent to Superannuation clearing house APIs. Must be exactly 11 digits, numeric characters only, first digit cannot be zero. Can be presented with or without spaces (e.g., ‘34623710896’ or ‘34 623 710 896’).
​
string
Current MVR (Member Verification) status for this employee, set automatically once their fund identity is known. One of NOT_APPLICABLE, PENDING, VERIFIED, WARNING, REJECTED, NOT_SUPPORTED, TIMED_OUT. Absent immediately after creation if no usi/smsf was provided yet. See the MVR Verification page for what each value means for payment eligibility.
​
string
Human-readable reason for the current mvrStatus (e.g. why verification hasn’t started, or the fund’s rejection reason).
​
string
Created timestamp
​
string
Updated timestamp
​
boolean
Always false for error responses, indicating the operation did not succeed.
​
integer
HTTP status code indicating the type of error. Common values: 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Server Error)
​
string
Human-readable error message explaining what went wrong. May include specific details about which field or value caused the error.
​
integer
Superannuation clearing house-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes. Common codes: 4030 (Employer not found), 4031 (Invalid ABN), 4040 (Fund not found).
Last modified on November 10, 2026