Credentialing

Need some guidance on credentialing within Developer Portal? Review this content for some quick reference guides and to gain a general understanding of how credentialing works for this system. 

On This Page 

  1. Open Authorization (OAuth) 
  2. Obtaining Credentials Chart 
  3. Understanding Credentials in the API Integration Process

 

Open Authorization (OAuth) 

Most of the Freddie Mac APIs use Open Authorization (OAuth), but the Pricing and Committing APIs use Basic Auth. Open Authorization (OAuth) is an open-standard authorization protocol which provides a way to safely allow authentication to assets without sharing API Product credentials directly with each call. It provides a means for the API provider to grant ongoing access (via token) to the API Product by showing that the user has permission to access those API Products. You will need to generate a token each time you call an API. See how the token works below: 

 

S2S ID and S2S Password: Your System-to-System Credentials are the credentials granted to your organization. They have "sys" in the username and password. 

Client ID and Client Secret: These credentials are created when you follow the steps to Create an App. There are two sets of these credentials: Test and Live. You will use Test when testing your API integration and Live when you are ready for your API to go live. 

 

See how to generate an OAuth Token below: 

 

 

See how to execute a Schema Request below: 

 

 

Obtaining Credentials Chart 

See what credentials are created and needed throughout the process of API integration. 

Understanding Credentials in the API Integration Process 

See what credentials are required and created throughout the process of API integration. 

 

 

 

 

 

 

 

This information is not a replacement or substitute for the requirements in the Freddie Mac Single-Family Seller/Servicer Guide or any other contractual agreements. This information does not constitute an agreement between Freddie Mac and any other party. © 2024 Freddie Mac.

Terms of Use Freddie Mac Learning