logo

Create an Experian credential

Creates an Experian credential.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Experian credential resource.

username
required
string

Username of the Experian account.

password
required
string <password>

Password of the Experian account.

hmacKey
required
string <password>

HMAC key that is used to generate the signature for Experian requests.

publicKey
required
string

HMAC public key that is included in the signature for Experian requests.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

Responses
201

Experian credential created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
username
required
string

Username of the Experian account.

password
required
string <password>

Password of the Experian account.

hmacKey
required
string <password>

HMAC key that is used to generate the signature for Experian requests.

publicKey
required
string

HMAC public key that is included in the signature for Experian requests.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
303

Existing Experian credential retrieved.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/credential-hashes/experian
Request samples
application/json
{
  • "status": "active",
  • "username": "string",
  • "password": "pa$$word",
  • "hmacKey": "PxOclToLSxW4oAB5N5HSdfoslyEWuvfkLjfHeNG2aZY~",
  • "publicKey": "8831AA5552FE10CD"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "pa$$word",
  • "hmacKey": "PxOclToLSxW4oAB5N5HSdfoslyEWuvfkLjfHeNG2aZY~",
  • "publicKey": "8831AA5552FE10CD",
  • "_links": [
    ]
}
➔ Next to Retrieve an Experian credential