AuthMe
  1. User Identities
AuthMe
  • Getting Started
  • User Identities
    • Create Identity
      POST
    • Retrieve an Identity
      POST
    • Generate Param
      POST
    • User identification
      POST
    • Login user
      POST
    • Login legacy user
      POST
    • Authenticate user by param
      POST
    • User remember-me
      POST
    • User renovate-token
      POST
    • User associate-user-device
      POST
    • Generates token when user navigates between applications
      POST
    • Generates an Access token
      POST
    • Renew Token
      POST
    • Create password
      POST
    • Change Password
      POST
    • Reset password
      POST
    • Get Identities from user
      GET
    • Remove Identity
      DELETE
    • Updates specific identity attributes
      PATCH
    • Provision logon in mainframe
      POST
    • Lock an user credential
      POST
    • Unlock an user credential
      POST
    • Remove Identity
      DELETE
    • Add Identity
      PATCH
    • Leverage MFA
      POST
    • Fulfill MFA
      POST
    • Generate token to login with digital certificate
      POST
    • Authenticate with digital certificate
      POST
    • Generate a renew app token based on SAML integration informed data
      POST
    • Associate legacy logon by email
      POST
    • Associate legacy logon by mobile
      POST
    • Complete Associate legacy logon
      POST
    • Retrieve a legacy identity
      POST
    • Reset a legacy identity
      POST
    • Add alternative contacts to use on MFA process
      POST
    • Retrieve all user authentication factors
      GET
    • Update an alternative contact to use on MFA process
      PUT
    • Delete an alternative contact
      DELETE
    • Send a token to an authentication factor
      POST
    • Validate a Token previously sent to an authentication factor.
      POST
    • Grant Auth Smart Role
      POST
    • Login using federated accounts
      POST
    • Add alternative contacts to use on MFA process
      POST
    • Partial update to alternative contact to use on MFA process with adminstrative roles.
      PATCH
    • Delete an alternative contact with administrative roles
      DELETE
  • Client Identities
    • Create Identity
    • Remove Identity
    • Bulk Migrates Client Identities Organizational Structure
    • Login client
    • Login client
  • My Client Identities
    • Create Identity
    • Remove Client Identity
  • User Accesses
    • Groups - List Users
    • Groups - Add User
    • Groups - Remove User
    • Groups - List Business Users
    • Groups - Add Business User
    • Groups - Remove Business User
    • List User Roles
  • Business Accesses
    • Groups - List Business
    • Groups - Add Business
    • Groups - Remove Business
    • List Business Roles
  • Service Accesses
    • Groups - List Services
    • Groups - Add Service
    • Groups - Remove Service
    • List Service Roles
  • Product Accesses
    • Generate Opaque Token
    • Validate Opaque Token
  • Keys
    • Gets public key used to validate JWT
  • Corporate Groups
    • Creates a corporate group
    • Lists corporate groups
    • Gets corporate group by id
    • Updates a corporate group
    • Deletes a corporate group
  • Customer
    • Creates a Business Customer
    • Creates a User Customer
  • Identific
    • Create a new ApiKey for the Identific
    • List all ApiKey
    • Update an ApiKey
    • Delete an ApiKey
  • Groups
    • Creates a group
    • Lists groups
    • Gets group by id
    • Updates a group
    • Delete a group.
    • Creates a group role.
    • Deletes a group role.
    • Creates a group dependency.
    • Deletes a group dependency.
  • Generate Token
    • Generate a access token and a refresh token
  1. User Identities

Retrieve all user authentication factors

Prod Env
https://api.serasaexperian.com.br
Prod Env
https://api.serasaexperian.com.br
GET
https://api.serasaexperian.com.br
/security/iam/v1/user-identities/me/authentication-factors
User Identities

Responsibilities#

Retrieve authentication factors filtered by AuthenticationFactorSettings previously by an admin.
Each application clientId have your own filtered tag settings or returns the default value.
Possible values include:
CREDENTIALS_ONLY: Default value, only returns credential authentication factors like the main e-mail and main mobile.
MARKED_RESOURCES: When application clientId is associated with this tag, returns alternative authentication factors tagged with MARKED_RESOURCES. Only an email and a mobile can be tagged with MARKED_RESOURCES.
UNRESTRICTED: When application clientId is associated with this tag, all main and alternative authentication factors will be returned.

Requirements#

To access this endpoint, the client (application) must have one of the following sets of roles:
CLI-AUTH-IDENTIFIED and CLI-1STPARTY and AUTH-BASIC and USER
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.serasaexperian.com.br/security/iam/v1/user-identities/me/authentication-factors'
Response Response Example
200 - Example 1
[
    {
        "id": "5efd263cbe2d398bb00b97ea",
        "contactType": "EMAIL",
        "email": "ex***le@br.e*******.com",
        "mobile": {
            "regionCode": "55",
            "areaCode": "11",
            "phoneNumber": "*****2222"
        },
        "tags": "[\"MARKED_RESOURCES\"]",
        "credential": false,
        "default": false
    }
]

Request

None

Responses

🟢200OK
application/json
Authentication Factors
Body
array of:
id
string 
required
Unique identifier to alternative contact, main-email or main-mobile
Example:
5efd263cbe2d398bb00b97ea
contactType
enum<string> 
optional
Contact type
Allowed values:
EMAILMOBILE
email
string 
optional
Example:
ex***le@br.e*******.com
mobile
object (UserObfuscatedMobile) 
optional
regionCode
string 
required
Example:
55
areaCode
string 
optional
Required for Brazil region code (code = 55)
Example:
11
phoneNumber
string 
required
Example:
*****2222
tags
array[string]
optional
When a tag is applied to an authentication factor, associated rules can be executed to change tags from another authentication factors. These tags are also used on parameters to filter results when retrieve the contacts.
Allowed value:
MARKED_RESOURCES
Example:
["MARKED_RESOURCES"]
credential
boolean 
required
Example:
false
default
boolean 
required
Example:
false
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
🔴500Server Error
Modified at 2025-04-11 12:00:41
Previous
Add alternative contacts to use on MFA process
Next
Update an alternative contact to use on MFA process
Built with