Architectural Overview
House Number Concept
Innovis uses a House Number architecture that allows resellers to service multiple end-user customers through a single Innovis customer configuration.
How it works:
- Innovis assigns resellers with a unique House Number Customer ID (your reseller identifier) for each permissible purpose/Innovis product combination to be used by the reseller. *
- Innovis assigns you unique End User Codes for each of your end user customers (see Support and Resources for end user customer setup instructions).
- For each API request, you pass your House Number in the customerId field and End User Code in the endUserCode field
- You may also pass your end-user customer's name in the endUser field but will not be used for the inquiry
- Inquiry appears to consumer as: "[Your Company Name] on behalf of [your End User Name]" as registered for the end user code.
Note* In some cases, SECONDUSE and REFUPD may be used on House Number Customer IDs set up with other products. Consult with the Innovis API team for guidance
Example:
{
"customerId": "1234567890", // Your House Number
"endUserCode": "9876543210", // Your end user customer's code
}
Benefits:
- Single integration supports all your end-user customers
- No need for separate Innovis setups for each customer
- Simplified credential management
- Product configurations are consistent across all your customers
- Easy onboarding of new end-user customers
Important Notes:
- The endUserCode field is required when using a House Number Customer ID - Each API request must include both your House Number and an End User Code.
API Request Flow
Standard request flow:
- Obtain OAuth 2.0 access token
- Construct API request with required fields including your House Number and end-user identifier
- POST request to appropriate endpoint with OAuth token in Authorization header
- Receive response with consumer data and reference numbers
- Store critical fields (reportReferenceNumber and consumerId) for potential SECONDUSE requests
Updated 4 days ago