User API

REST APIs for Users

User API calls must originate from the end-client

Equifax end-points are accessible by first using the User API /users/efx-config response data, and then the Equifax /oauth/token call.

User API and Equifax API calls are intended to be called from the end-client/user's device.

Endpoints

Endpoints above are all available to the customer and require a preauth token, returned from /direct/user-reg or /direct/preauth-token

Endpoints above are not available for use when Direct API calls are used.

Preauth Token (get)

/users/preauth-token/{paToken}

• This request uses userId (from the response of /direct/user-reg) to generate a User Token.

  The Preauth Token needed for this request is also generated by /direct/user-reg or /direct/preauth-token

User Identity (post)

/users/identity

This endpoint is most useful for checking whether the user's identity needs to be verified.

If the response has idpass set to true, then the user's identity is already verified.

If idpass is false, then the user's identity needs to be verified.

The user's identity can be verified with either:

• /users/get-mobile (phone sms verification)
• /users/get-quiz (an identity quiz)

The user's identity must be verified in order to enable the user's device to request the Equifax config data.

The data in the Equifax config provides the necessary credentials for making requests to the Equifax API from the consumer's device.

Phone Verify (get)

/users/get-mobile

Send Mobile Code (post)

/users/send-code/{mtoken}

Renew Mobile Code (post)

/users/renew-code

Verify Mobile Code (post)

/users/verify-code

Get Identity Quiz (get)

/users/get-quiz

Verify Identity Quiz (post)

/users/verify-quiz

Get EFX Config (get)

/users/efx-config

Use this endpoint to get the Equifax credentials and url

These will be needed for the consumer app to send requests to the Equifax API.