Quick Start Guide

Origence Connect REST APIs

1. Sign up or log in

Sign up to create your free developer account. If you already have an account, log in using your existing credentials.

Sign up →

2. Account activation

After successfully creating your account, please check your email for instructions on how to activate it.

3. Log in to Origence Connect Developer Portal
Log in →

4. Browse APIs

To browse our full collection of APIs, your account must first be approved by an Origence representative. To become an Origence Connect Partner, please contact Origence to get started.

5. Create a new product subscription

To access and integrate with our APIs, you must submit a product subscription request for approval. Additionally, you can manage your account and subscription details conveniently in the User Profile section.

6. Access token

The Origence Connect APIs necessitate an OpenID Connect (OIDC) compliant access token. During the implementation phase, you will receive client_id and client_secret credentials for each environment. These credentials are exchangeable for a JWT (JSON Web Token) bearer access token, which must be incorporated into the Authorization header for every API call.

7. Try it

After logging in, you'll be able to access the API Reference page. Here, you can explore the available APIs, API operations, and API definitions. Take advantage of the "Try it" feature right within the Origence Connect Developer Portal to effortlessly test the APIs.

8. Mutual Transport Layer Security (mTLS)

Origence Connect requires Mutual Transport Layer Security (mTLS) certificates for incoming external requests. This entails clients supplying Origence with a public certificate signed by a reputable Certificate Authority during the integrator implementation phase to connect to APIs, enhancing security measures.

 

9. Environments

In all cases, Origence will provide the appropriate per-environment credentials to you during the integration setup process.

We provide the following environments per Integrator organization:

Non-Production API environment: https://uat-api.origenceconnect.com

  • Developer Portal enables you to develop in a testing environment that's isolated from the production environment to test APIs and products without affecting live data.

  • Used for integration development and testing with non-production credentials and subscription keys.  

Production API environment: https://api.origenceconnect.com

  • All API requests to production will be with live data with go-live production credentials and subscription keys.

Which environment you want to operate in will determine part of the base structure of your route URLs.

10. Go-Live

Once you're ready to go-live and begin using your integration in our production environment, you'll need to acquire separate credentials and subscription keys to access APIs. Credentials and subscription keys will be securely delivered by an Origence specialist.

11. Close an account

Origence Support can close a developer account that is no longer in use. This prevents anyone from logging into the app with that account or using it to send API requests.

To close your account, go to your Profile page and select Close Account under your Account details section. Origence cannot reopen a closed account, but you can create a new account if needed.

Contact Us

If you have questions, you can contact us at (833) 908-0121 or you can submit an inquiry on our Support page and an Origence specialist will contact you for assistance.

Please include the following information:

Your Company Name

Your Name

Contact Phone Number

Developer Portal Username

Join our developer community!

To begin utilizing our API services, simply register for an account.
Once you've created your account, you'll receive a confirmation email to activate it.