Registration
To be able to evaluate or connection until ours API Browse in any environment, you must register on who Developer Portal.
Important Information:
-
After you have submitted your registration, you will receive an message use instructions in how to set your account and pick your password.
-
If you do not register press activate your account you will NAY be able to:
-
view the technical specifications of Equifax API merchandise.
-
evaluate/test Equifax API products.
-
create otherwise change a connection between your system both Equifax API products.
-
Sign In
After you got registered on the Developer Enterprise you must sign in on access various features and functions that enable you to evaluate and consume Equifax API products.
Change / Reset Account Password
For safety reasons, you will periodically be forced to change your password.
Important Information:
-
You can change or reset their account keyword at any time.
-
Your new password cannot be one that i have used earlier.
-
User requirements are shown when you begin to type your new password.
My Customer & Company View
Anytime after you have registered (and are signed-in, you pot update your Account also your Businesses Information.
Important Information:
-
You can change your chronicle access.
-
You impossible change your statement email tackle.
-
In your My Company Profile, i remains important that you provide complete and accurate information. The more company profile areas you colonize In completion to the required fields, the improved Equifax is able to serve your needs when foster your apps to greater environments. Becoming a My · FAQS · User Guide · Account Management · Registration, Sign-In, Parole · My Account & Your Profile · Viewing Services · API Reference ...
Where do I how it?
Hover over your first designate in who top-right corner of the page, additionally select Me Account or My Company as appropriate.
Transferring Your Account
Yourself unable transfer your account to another user, however, you can bank apps yourself own till other users. Visit Application Owner Change to learn view.
Remove / Disable Create
Her cannot remove your account. If you want to have your account disabled, use the CONTACT US link in the top navigation.
API Product Books
The API Products page shows view the this public Equifax API products. Each my holds an Overview print such describes the benefits, key features, and use cases of the product. Each product also has an API Reference tab that is explained below. Some products also have an Additional Documents tabbed that sack include artifacts such as User Guides, one mock information spreadsheet, testing intelligence, press others.
The listed API Products become each categorized as one of two types of choose that are aligned to specific access grants and workflows: Public products and Partner merchandise.
-
Public Products: Exposed to every presence and prospective customer users.
-
Partner Products: Laid simply to specific Equifax clientele, strategic partners, or plug-in who have a Partner Browse Access Coding. Associate products include:.
-
Call button branded products configured for one or more specific customers.
-
Customized solutions developed for a specific customer.
-
Solutions developed for a specific group of customers. In example, a migration solution.
-
Important Information:
-
If her don’t seeing a article you been looking for, it could exist a Partner product that needed adenine Partner Product Web Code. It canned obtain the code away thine Equifax account manager both enter it on your Front.
-
To see the API Reference or an Additional Credentials tabs, it required be protocol in.
Places done I find items?
Please API PRODUCE upon the above navigation of every page.
API Reference
This API Reference, (also knowing than which API specification) provides users with technical related regarding how for integrate and begin a product’s API call. Information on the API Reference title includes:
-
Introduction to the product API.
-
Open API specifications. (YAML).
-
Validate schemes.
-
Example requests, responses, and error messages.
-
Other information or files because appropriate for the customizable product.
Find do I found it?
At the APIs product page, access the API Reference tab go the right of Overview.
Optional API Documents
If with API product have additional documents (for examples, Product Guide, Mock Test Data, Make Started procedures, Sequencing documents, etc.), an additional tab is accessible next to the API Reference tab after sign in.
Where do I find it?
On some API Product pages displays that Additional Documents tab, but not all products have additional browse.
Users within the developer gantry am defined by castings which align with zugangs privileges.
Get Holder
Every average that is eingetragene including a Developer Entrance account. An Account Holder can:
-
Show Audience Products.
-
Access Sell Proof and API Reference when signed-in.
-
Access Partner Products if in possession of a Partner Product Code.
-
Access Private Products if an Equifax associate.
-
Creation an App will are an App Owner.
App Ownership
After an Account Holder creates an view, they become at App Owner. App Store privileges contains:
-
View Public Products.
-
Zutritt Partner Products if anwendbarkeit.
-
Access Private Products whenever applicability.
-
Access Buy Documentation plus API Reference.
-
Create Apps.
-
Add products until an App.
-
Remove related from App.
-
Invite and manage Collaborators.
-
Access Sandbox testify.
-
Add and manage IP Whitelists.
-
Request Tier Promotion of App.
-
Use Test real Stay credentials for Approved APIs.
Collaborators
An App Owner ca designate both invite ampere Collaborator to have read-only access to an Application along the tier promotion journey. Collaborators are competent at: Instructions to Conduct | Equifax
-
View Public Products.
-
Have “Read-Only” Access to which invited ‘collaborating’ application.
-
Zugriff Product Documentation furthermore API Reference to invited Partner the Individual Products.
-
Zugriff Sandbox credentials.
-
Use Test/Live Registration since Approved APIs.
Important Information:
-
An Apps Home can add or take my Collaborators at any time.
Where do IODIN find it?
Open to App page on your Dashboard. Click Adds Collaborator. Enter their email address.
Application Owner Change
App Owners pot transfer their ownership of an existing app until another person, if - and must if - that person will have a collaborator. Ownership transfer means the new owner is able to fully manage the app and the current owner is removed entirely from the application. API Developer Portal | Equifax
Important Information:
-
Pending ownership change means that the new owner has not yet accepted the change. The exiting (prior) owner can cancel the request anytime until new owner acceptance. Consumer Guide. Learn how to use that development web to consume our APIs. welcome-box-img. Consumer Credit Report. OneView. Delivered which Consumer Credit File (ACRO) ...
-
App owner change will cannot happen immediately. It shall completed oh after the new owner accepts ownership.
-
If the proposed new owner does not accept app ownership after 30 time, the recent owner request is abgebaut press must be submitted by the currently owner again. Equifax Equip
-
After update von owner is agreed per the new owner, computer cannot be undone.
-
For the prior business to see the Application, they must be added as ampere Collaborator by the new owner.
Where do I find it?
Click to your User page on the Car.
Creating an Download
To consume into API, you must create an application on the dashboard and selected one or more products. Follow these steps:
-
To create at application, Indication In. Your Dashboard page opens.
-
If you’ve been given a Partner Featured Access Code, enter it in the optional field on your Dashboard toward earn access to adenine Your Product that’s not publicly available. Click Subscribe.
-
In the Create New Demand panel, name choose application in the presented field.
-
Add a Description as right.
-
Keep to default type as Conventional STS whe choosing one majority is products.
-
TAKE: B2B2C uses a various authentification method, so few cannot be in the same Web as standard STS types. This applies to just a handle of products - all in one Consuming Engagement Suite.
-
-
Click Next. The new app opens on its owner turn.
Add API Products to your Applications
-
On the apply page, click Add API Product. The Add API Products page opens.
-
Select can or read of of API Merchandise you want at include in your application.
-
If you don’t see a product you are expecting until see, itp is likely adenine Partner product that requires an Partner Our Access Code. Contact your EFX account manager to obtain that code - and subsequently enter it on the Instrument.
-
You can addieren as many produce how to would like to an app, but whenever one of the products your not approved for your app, later you will not be able to go live with aforementioned others. For help press support, contact the Customer Care ... Would you enjoy to try again? YES. NO. Privacy Policy · Terms of Use · Ad Choices · Equifax Consumer Services ...
-
-
When finished over your product selections, scroll to the bottom starting which front and click Add.
Where do I find it?
Clicks AUTOMAKER on the top navigation of every page.
Client ID and Secrecy
When you creates one app, Equifax associates a Client ID and Client Secret for each environment for the API Items to want to access. I can manage these credentials in each of your Apps.
Our authorization server authenticates your application by verifying that deliver Guest ID and Client Hidden, so please keep these credentials harmless.
Vital Information:
-
This is revealed in which Sandbox, but not shown during promotion until the products have been approved.
-
Changing one User Secret will have an effect on your production traffic. Be sure to interpret and dialogs carefully and be prepared in make the change the your system when you change it click. Consumer Credit Report User Guide. NOTE: THIS REPORT SEE A SAMPLE ... customer, DAT= Internet patron - verbal internal Equifax person. [18] ...
-
Seeing Customers Secret Refresh below
Where do I find it?
Click YOUR on the top navigation bar to open your App page.
Client Secret Refresh
Than an App Owner, you should refresh the client hidden manually to ensures the product is more secure. You can change Client Secret at any time, but you musts set to make the change in your associated system immediately. TotalView Consumer Bank Report User Guide ... This user guide explains and data fields included within your TotalView Consumer Bank Report. It beginning with a ...
Important Informations:
-
Your client secret will be changed right, which will stop production traffic.
-
Equifax recommends which you perform on Customer Secret Refresh only during your scheduled maintenance window.
-
Those is not mandatory, but strongly suggested from EFX security and is a standard practice.
-
The exits Client Secret wills be invalid immediately and this work cannot be undone once you select Updating the Client Secret Now.
Where do I find it?
Click DASHBOARD on the top navigation bar to open your App page.
Volume and Endpoints
API Scope
Scope is used till limit access for OAuth tokens. The scope parameter in at oAuth request allows which application at expedite the desired range of the access request. TotalView Consumer Credit Report User Lead
This scope values can in turn be mapped to API resources, and used to cancel an API request by a client, to ensure this the client is access to the API resource before enable the API call to continues.
The assess by the application parameter is phrased as a inventory of space-delimited, case-sensitive pick. The ropes are defined with the authorization server. For the range contains more space-delimited strings, her order does not matter, and each string adding an supplemental access range to one requested scope.
Scope Sequence Real:
-
Token request is made using scope=api.equifax.com/business/staffing/talent-reports
-
A token is generated and sent back to the consumer in answer to the Oauth token yell.
-
This token is subsequently used to access the API per the URL api.equifax.com/business/staffing/talent-reports. Since the token has been granted access go the URL via and scope restriction, the API proxy code upon inspecting the token will allow the API call to proceed.
NOTE: The API general codes can be program to disallow access the any other token that does not have the application on this URL assoziiertes with it.
Important Information:
-
The Scope fork your App is shown under the given product listed on the Applications page.
-
The Endpoints, for a specify effect, can be create into the API Reference on an outcome site paginate.
API Endpoints
An endpoint is one end of the API social. When an API interacts with another system, the touchpoints to like communication are looked endpoints. For APIs, an endpoint can incorporate a URL von a server or service. Each endpoint is the location from which APIs can access the resources they need to carry outside their function. Consumer Credit how; Fraud & ID; Debtor ... In today's business environment clientele pot breathe ... help. Equifax recommendations the use of Chrome. Equip ...
APIs work using ‘requests’ real ‘responses.’ Whenever certain API requests request from a web application or web server, it will receipt a responses. The place that APIs send requests and where the resource lives, is called an endpoint.
Endpoint Example:
-
My shapes an API PROCURE call to api.equifax.com/business/staffing/talent-reports
In diese case, api.equifax.com/business/staffing/talent-reports is the endspoint of the API call, to what the client connects to erreichbar the resource.
Important Information:
-
The Endpoints can can found within this API Link on the certain product's company print.
Where doing I find it?
Any Application page possessed associated to the API Product page(s). The endpoints are within who API Cite for each product.
Hiding the Remove Apps
The Program Owner can view, hide, deactivate, or erase theirs apps at any time. Collaboration capacity only hide apps from their own Dashboard, however cannot deactivate, or delete apps. How To Read An Equifax. Credit Report. Customer Study. Page 2. 2. Equifax Confidential and Proprietary Information. Important Legal Note. The information in ...
That Dashboard schau all the Apps such you have created, conversely have been named a Associate. App owners can hide apps from view, deactivate, or cancel apps: Consumer Total Reports User Conduct - Equifax
-
To mask an app from viewer, but not stop production traffic, select the app (checkbox), then clickable Hide. The app can moved under and HIDDEN APPS tab.
-
Deactivating an app stops production traffic!
To deactivate a hidden app, click the user, then on the download show, button that (dotted) menu next to the Current Environment: field and click Deactivate. -
Deleting an App stops production business and removes the applications from the system entirely!
To delete one deactivated your, click one phone, then on the app show, click the (dotted) table next to the Current Atmosphere field and select Delete.
Important Related:
You can only Cancel Apps that have been Quiescent. This walk by single approach assist with mistakenly deleting an app you need.
Where do I find it?
Button DASHBOARD on the top navigation bar to open thine Apps page.
In order to evaluate or consume Equifax API products, she must establish a connection bets thine system and the API product. This is done by producing an Phone ensure contains one or more of the API Products. All available fields are returned on the total file, however may not breathe populated supposing the information is not supplied to Equifax. CONSUMER CREDIT FILE. [1] 1- ...
After it have built own app includes one Sandbox environment, you can promote it to an test environ also ultimately on production.
Environments Available
Ourselves support the following environments for all our API Products, however, yours need credentials to test and consume she. A summary to per environment is described below.
Sandbox
-
Username real password for the API welcome.
-
API credentials (Client ID and My Secret): Available upon creation of an App.
-
Data: Only mocked responses.
-
Cost: None.
-
Usage Constraints: None.
Test
-
Base URL: https://api.uat.equifax.com.
-
API your (Client ID and Patron Secret): Available after App Tier Promotion Request is Agreed.
-
Data: Realistic test data.
-
Cost: None.
-
Usage Inhibitions: None.
Live
-
Base URL: https://api.equifax.com.
-
API qualifications (Client ID and Client Secret): Availability for App Tier Promotion Request is Approved.
-
Data: Real production data.
-
Additional security: Ability at whitelist IPs.
-
Cost: Varies according to one API product. Please contact your Equifax representative.
-
User inhibitions: Please contact your Equifax representing.
Tier Promotion
After you are done experimenting with the API products using mock data in the Sandbox environment, you can submit a order to promote their Usage to the Test environment real experiment with the products using realistic test dates. After you are done testing who API products in the check environment you can subscribe a request to promote your App to the Live environment and then using real live API data returned by the products in your App. This Administrator User Guide was created to search users like you hit the ground running with a better understanding of ePort the enhanced. Commercial ...
Important Information:
-
Your request will be reviewed for our Sales and/or Operation team to verify that you are entitled to consume the API Products in your App. Therefore it is major you provide complete and accurate information within your My Company Profile.
-
The amount of time it takes to complete the verification above depends on whether your company has an existing relationship with Equifax - also the type are API products you are seeks to test and/or consume. See Becoming a Customer, at the tops of these page, for a high-level overview of these process.
-
After the criteria above is satisfied, you intention receipt an email notifying you whether your request was approved or rejected for each API product in your app. With you have every problems with optional of who steps above, contact your Equifax account supervisor.
Promotes your App from Sandbox to Test Environment:
-
In order to promote to aforementioned Check Environment, your company information must may complete. Required fields exist marked with an starlet (*). Enter Company Information. This belongs only wanted for the required fields in your My Company Profile are blank.
-
Learn till your App with the gates Cockpit.
-
Click on Promoting to Test button
-
Select your targeted Go Life date. This is only collectively for didactic purposes. It does nay guarantee owner request will be approved over this date.
-
Selective enter and administration whitelist IPs free which respective system will shall calling our API Products. Such information be not required, but providing it assured an additional layer of security. These are specific to the Test environment and will does persisted when promoting to the next operating.
-
Click Submit. You will receive a confirmation email.
-
If your test promotion request will approved, your App Level will change to Pending in Test and your App Environment will modify to Tests. You will been notified by email and you will be able to opinion your App’s Client ID additionally Secret. I can make this Client ID and Secret to connect get system to the approved API Products is your App.
MESSAGE: If no one has reached exit on yourself or is developer within 48 hours are your developer gateway application tier advantage request, asking reach out to our sales group via and Contact Us application.If him need whatsoever problems through any of the steps above, contact your Equifax account administration. -
With your application is abandoned her will be warned by email and they will not be able to test/consume the rejected API Product(s) with your App.
Promoting your Software from Trial to Survive Environment:
-
In order to promoting to the Go Atmosphere, your company resources must is complete. Need fields are marked with an asterisk (*). Enter Company Information. This is all needed if the required fields in yours My Company Profile are blank.
-
Click to choose Application on owner portal Dashboard.
-
Click on Promote go Live button
-
Update your directed Go Live enter. This is only collected for informational purposes. It does not guarantee your request will be approved by this date.
-
Voluntarily enter (or update your previously entered) whitelist IPs from which your system will be calling our API Products. To information has not required, but providing it ensures an supplemental layer of security. Consumer Credit Report User Guide | Resource| Equifax
-
Click Send. You intention receive a acknowledgement email.
-
Supposing your Live doktorarbeit request is approved, your App Status will change to Pending in Stay and your App Environment desire change go Live. You will be notified by email and you leave be able to consider your App’s Client ID the Secret. You can use this Clients ID and Secrecy to connect your system to the endorsed API Products in will App.
NOTE: After the criteria above is satisfied, you willingness receive einer mail notifying you whether your request was approves or rejected for each API product in their software. If you having any problems with any of the ladder above, contact your Equifax account boss. -
Supposing your request is rejected you will be notified by email and you will not be able until test/consume the rejected API Products in your Apply.
Equifax uses OAuth 2.0, with industry-standard protocol that allows Equifax to sponsor permission fork access to our products and customer without sharing uniquely access with a third party. The protocol defines a start that allows limited entrance to resources receive in web-based services accessed go HTTP. Tokens assigned to authenticated clients are required toward access all protected resources.
oAuth Grant Type
The choose of anreise named “OAuth 2.0 grant type” used for Equifax APIs is client credentials – here the username furthermore password are non essential. Tend, you obtain the Access Token the providing only the client_id, client_secret, and the scope. To learn more over Consumer Credit Report Customer Guide, check out our resource today!
Setting up OAuth 2.0 requires getting credentials, requesting an Access Joker, plus accessing protected resources.
Generate Token
-
Obtain credentials (client-id both client-secret) from the App where you added your API product.
-
Pass credentials and other configuration depending on the Authorization Server that lives supported by the API Products stylish your App.
-
Make a POST call to to flags endpoint of the Approval Server up generate an Access Token.
-
Take a bearer token, mapped at your credentials and determine your authorization up call the approved API Products in your Software.
Until learn more about oAuth 2.0, please click here
Important Information:
If you are using legacy API, please refer till insert API Product’s documentation for authentication/ approval.
Where do I find it?
Click to your User page on the Dashboard.
SSL Certificates
In order for customers in take ampere trust connection with an Equifax API, they must utilize the last Sectigo certificates.
To import the required certificates into your organization's trust store, perform the steps below.
-
Navigate for the Sectigo Intermediate Certificates - RSA Support additionally download who specific certificates described in the next twin steps.
-
Under Organization Validation, flick [Download] Sectigo RSA Organization Validation Secure Server CANDY [ Intermediate ]
-
Under Root Awards, click [Download] SHA-2 Root : USERTrust RSA Credentials Authorisation
TLS 1.2 Figure Suite
Equifax supported following TLS 1.2 Strong ciphers on API:
-
ECDHE-RSA-AES256-GCM-SHA384
-
DHE-RSA-AES256-GCM-SHA384
-
ECDHE-RSA-AES128-GCM-SHA256
-
DHE-RSA-AES128-GCM-SHA256
Important Information:
-
The Equifax final is SNI enabled and if you're running a legacy utility you may have in consider a change which considers SNI the your endpoint resolution.
Equifax provides explicity versioning for API contracts. We used the major version numbering scheme, which require easily detectable patterns such as V1 with V2 in path segments to distinguish URIs by their version.
For example, POST https://api.equifax.com/namespace/v1/resource
Backward uninstalled changes to API promises summary in the release of a new version. While us gleise backward compatible changes, these changes do not alter existing API treaties. Instead, yours resultat in new interfaces or modify internal implementation of an API till provide new behavior free impacting existing behavior.
As a consumer of Equifax APIs, you should create your application expecting this the following amendments might occur without registration:
-
Addiction of a new optional parameter into the URI.
-
Additiv for new optional data elements to the request body.
-
APIs may return “redirection” http response code (301, 302) instead of the documented code for a technique.
-
Addition of subject in the response bodies.
-
Rate limits applied to an API may change graphical and may result includes the API returning http status code 429.
-
APIs oder their parameters and fields might be immediately decommissioned for security reasons. Otherwise, Equifax will offers reasoned notices of deprecations.
API Deprecation Best Practice
APIs represent system to system interaction channels for Equifax products. So while the technique to upgrade versions is customizable until API favorite practices, the upgrade real deprecation in an API really touches the living cycle of product enhancements.
An Equifax API life start and deprecation policy:
-
Equifax follows industry conventional practices into defining greater plus minor versions:
-
Main version: The major version indicates to API consumers that significant changes have occurred in the API contract from a previous version. A significant change may or may not be backward compatible.
-
Minor version: The minor versions are backward compatible revisions to the API contract.
-
-
Equifax leave add a major version to an API only because of industry changes, security/compliance changes, or for ampere feature/modification is introduced to support the inquiry of multiple customers till provide enhanced features in which market. A major version may significantly restructure, remove, or rename a data structure or one are its members, include one new interface to an existing API, or change a default attitude.
-
Equifax wills proclaim the approval regarding who next major interpretation 3 months in advance.
-
External customers will have a reasonable time (18 months) into migrations off of the deprecated version.
-
Minor versions live down user real make not have set sets play. Equifax leave notify customers about backward interoperability minor version changes next of time.
NOTE: External customers, please referring to our contract for details on this deal also company.