Overview
Before you can use Connect API, you must authenticate using your assigned username and password. Authentication generates a secure access token that allows your application to access Connect API services. The access token must be included in all API requests.
Prerequisites
Before getting started, make sure you have:
- An active Connect API account
- Your Connect API username and password
- Access to a tool or application that can send API requests
- Access to either the Sandbox or Production environment, depending on your setup
Key Authentication Terms
JWT (JSON Web Token)
A JWT is the access token returned after successful authentication. It verifies your identity and authorizes access to Connect API services.
Bearer Token
A bearer token is simply the JWT token used in your API requests. After authenticating, you include the token in the Authorization header of every request.
Token Expiration
Authentication tokens remain valid for 1 hour (3,600 seconds). When a token expires, you must authenticate again and use the new token for future requests.
How Authentication Works
Step 1: Authenticate
Use your Connect API username and password to authenticate.
When authentication is successful, Connect API returns a JWT access token.
Step 2: Save the Token
Store the returned token securely. Your application will use this token to access Connect API services.
Step 3: Include the Token in API Requests
Include the token with every Connect API request. This confirms that your request is authorized and allows Connect API to return the requested data.
Step 4: Renew the Token After One Hour
Tokens expire one hour after they are issued.
To maintain access:
- Authenticate again when the token expires.
- Obtain a new token.
- Replace the expired token in your application.
Best Practices
- Keep your username, password, and tokens secure.
- Reuse a token until it expires rather than generating a new token for every request.
- Have your application automatically obtain a new token when needed.
- Use secure connections for all API communications.
Need Help?
If you continue to experience authentication issues:
- Review your login credentials.
- Confirm your Connect API account is active.
- Contact Customer Support or your Creditsafe Account Manager for assistance.