Fedex Logo
Developer Portal

Credential Registration API

Introduction

FedEx API requires an OAuth access token to be provided with each API transaction to authenticate and authorize your access to the resources.

The Credential Registration API provides FedEx® Compatible solution providers the ability to onboard their customers by generating customer key and password, used for creating OAuth access token to execute API transaction.

Credential Registration API Prerequisite

FedEx APIs support the OAuth 2.0 (bearer token) authentication method to authorize your app and authenticate your API requests. This OAuth access token must be provided with each API transaction to authenticate and authorize your access to the resources.

Prerequisites

Following are the prerequisites:

API Key/Secret Key

FedEx provides a combination of an API Key and a Secret Key to authenticate API requests associated with your project(s). The API Key and the Secret Key will be associated with each project under your organization created by FedEx administrators.

Customer Details

Following are the customer details required while registering with FedEx:

  • 9–digit FedEx account number – The API endpoint documentation will specify whether a shipping account is required for the API call or not.
  • Customer address – The address information needs to match the shipping or billing address as loaded in FedEx systems. Contact FedEx support team for any address-related issues or questions.
  • Customer name – The name of the customer or the company registering with FedEx and requesting authentication details.

How Credential Registration API works

Create Customer Key and Password

This request is used to a create customer key and a password (secret) for a customer. To create a customer key API Key, API Secret, customer FedEx account number, customer name and address are required.

A customer key and password is a JSON web token provided for each of your customers.

For executing each API transactions, the customers must use the customer key, password along with the API key and API secret to get OAuth token.

To start using FedEx Credential Registration API endpoint, following are the high-level steps involved in the registration process:

  1. Get API key and secret key – The API key and secret key is generated when a project is created for you by the FedEx admin.
  2. Request Customer key and Customer password using API key, secret key, FedEx account and address details.
  3. Get an OAuth access token.
  4. Use this OAuth access token in API transactions.

Note: The access token expires in an hour, it can be regenerated by using a POST request to the OAuth/token endpoint.

Documentation Powered by ReDoc

Credential Registration API (1.1)

Create Customer Key

Compatible Providers can use this end point to generate Customer Key and Customer Secret for their customers. Customer Key and Customer Secret along with your API Key and Secret Key are required to generate OAuth token, which should be used in every API transaction.

Note: OAuth token generated with your API Key and Secret Key should be passed in the authorization header in this API call. Please refer to Authentication Guide for more information.

Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

query Parameters
appmode
string
Example: appmode=sandbox%2Clive

Specifies the level or mode where key is getting created.
Example: sandbox or live

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
address
required
object (AddressVO)

Indicates the customer's address you are attempting to get the Customer Key and Customer Secret for. Note that address information needs to match the shipping or billing address as loaded in FedEx systems. Contact FedEx support team for any address-related issues or questions.

accountNumber
required
string

This is the FedEx account number requesting authentication details.

customerName
required
string

Name of the customer or company requesting authentication details.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /irc/v1/customerkeys

Sandbox Server

https://apis-sandbox.fedex.com/irc/v1/customerkeys

Production Server

https://apis.fedex.com/irc/v1/customerkeys

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "address":
    {
    },
  • "accountNumber": "125478963",
  • "customerName": "George"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}
CLOSE

Response

Copy