Skip to main content

 

 

There is a dropdown in the Swaggerhub schema that allows you to switch the template from JSON to XML.

e-OSCAR currently receives one file per day from each of the Consumer Reporting Agencies, therefore a Data Furnisher would only need to request data once daily.

 

  • Requested - An ACDV Request that has been delivered to the Data Furnisher

  • Return to sender - An ACDV that contains a response code of 04 (misroute) and that has been successfully submitted

  • Pending - An ACDV Request that has been opened by the Data Furnisher

  • DF Submitted - An ACDV response that has been successfully submitted

  • Error - Not applicable as this status is going away

  • Incomplete - Not applicable as this status is going away

  • No Response - An ACDV that has not had a response submitted by the Response Due Date

  • Closed - An ACDV with a submitted response that has been packaged and sent to the CRA

Data Furnishers are absolutely able to utilize the Interactive application as well… They just need to be cognizant of the fact that if they touch the ACDV in the UI before they pull their ACDV Requests for the day via API and they are pulling by “status” of Requested, that ACDV will not appear in the call response because they will have already changed the status of that ACDV to Pending by touching it in the UI first. Also, they can only respond via one “highway” if the respond in the UI to an ACDV, they cannot respond via API and vice versa. Additionally, they can certainly use the UI for any service that they are not utilizing API for.

No, your API key is tied to your Registration ID, not the version of the API

No.  Your current billing cycle will remain the same.  

The pricing tiers for API usage are in addition to the $0.30 per transaction that you currently have today for the data transmitted via the e-OSCAR Application / batch process.

Our pricing algorithm takes into consideration your actual e-OSCAR transaction volume over a 12 month period and predicts the number of required API calls based upon our research and assumptions. We do not expect a one-to-one relationship between the number of transactions processed and the number of API calls required.

Accessing our endpoint documentation is a two-step process. You must first create an account with Swaggerhub. Once that is done, we will grant you access to our specific libraries.

All images returned via Services by e-OSCAR use Base64 encoding.

10MB per image with a limit of 5 images per record.

The API Key is unique to your e-OSCAR Registration ID. The API Key will be generated by OLDE and provided to you. The Authorization Token is unique to the API User ID and will be required to be refreshed no less than every 12 hours or after 30 minutes of inactivity via the Auth Token call within the Services.

The Validation endpoint is not a required call when submitting an ACDV Response, AUD or BRR. The Validation endpoint is available if the user wants to confirm that the information provided will be accepted prior to submitting the ACDV Response, AUD or BRR via the Submit endpoint. Any information passed through the Validation endpoint will not be submitted to e-OSCAR and will not be considered a submission. The validations included in the Validation endpoint are included in the Response endpoint as well.

It is recommended that users download the existing YAML files created in swagger to the web service client software (it is not required to use the existing YAML files to create your client, but it does make it much easier to create one by using it. You can always handcraft a JSON or XML to talk to API Services).

The Authorization token will be valid for 12 hours of activity within the API Services. The token must be updated after 12 hours of activity. If the activity is dormant for a period of more than 30 minutes, the Authorization token will expire before the 12-hour window and must be updated.

API User IDs are required to complete any API calls via the API Services. The API User ID and Password is the only User ID and Password that has permissions to make API calls. The API User ID and Password has no permissions to access any information within the e-OSCAR Interactive Application. e-OSCAR Interactive User IDs and Passwords have no permissions within the API Services.

API User IDs are required to complete any API calls via the API Services. The API User ID and Password is the only User ID and Password that has permissions to make API calls. The API User ID and Password has no permissions to access any information within the e-OSCAR Interactive Application. e-OSCAR Interactive User IDs and Passwords have no permissions within the API Services.

Data Furnishers are welcome to implement any of the Services offered by Services by e-OSCAR. It is not required to use all services endpoints. Data Furnishers are encouraged to use the Services that work best for their business model.

Notifications regarding any changes or updates to the Services by e-OSCAR will be communicated as all changes and updates are currently communicated today. The information will be shared on the News and Information Page of www.e-OSCAR.org, all changes to the schema for the Services will be housed in Swaggerhub in the versioning dropdown.

Once the Change Password call has been successfully completed within the API Services, the password is not going to expire. The only time the change password call will need to be initiated is if your organization has a policy that requires password changes on a particular cadence.

Services by e-OSCAR will require an API user to be created in the e-OSCAR Interactive application before any API calls can be made within the services. The following steps must be completed:

  • The e-OSCAR User Administrator for the UAT or Production environment will log into the e-OSCAR interactive application and access the Administration screen.

  • The navigation bar on the left -hand side of the screen will populate with an option for API User Management.

  • Select the option for API User Management and select the link to Create User in the Upper right-hand corner of the page.

  • A User Role will need to be selected:

    • API Receiver – Completes “get” calls only

    • API Initiator – Completes both “get” and “submit” calls

The API Matrix is a high-level document outlining use cases for the API Services endpoints. The endpoints listed in the Archive services are endpoints that can be called to retrieve information that may be used for Archive purposes. These calls will not change the status of the information retrieved in the call; therefore, will provide the data you may require for archive purposes.

Documentation for Services by e-OSCAR is housed in Swaggerhub. OLDE limits the access to no more than three individuals within your organization and will require a fully executed NDA prior to provisioning access.

Errors that apply to all endpoints The below errors are common to all endpoints:

Error Messages and Response codes:

  • 400: Invalid Request data
  • 401: User Unauthorized to access service
  • 403: User Forbidden from accessing Service
  • 404: Requested resource Not Found
  • 500: Internal Server Error

 

400 Invalid Request Data – issue can be determined by checking the detail in the error message.

The 400 error occurs when any of the following are incorrect:

  • Invalid value {0} in the field: {1}.
  • Registration Id can have numbers only:
  • Invalid User:

401: User Unauthorized to access service

The 401 error occurs when any of the following are incorrect:

  • Invalid Registration Id
  • Token Expired
  • Token Missing
  • Invalid Token
  • User not authorized for the service

403: User Forbidden from accessing Service

The 403 error occurs when a user doesn’t have the appropriate role to access the endpoint.

404: Requested resource Not Found issue is when the server couldn’t find what was requested. Check the link and retry after confirming the server is up.

500: Internal Server Error Retry after confirming the endpoint information is valid.

 

Questions?

Contact the e-OSCAR Help Desk at (866) MY OSCAR or (866) 696-7227
Monday - Friday, 8am - 6pm ET