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

Add Identity

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

Responsibilities#

Add an identity for a user that already has one.

Usage#

If the user has an identity with e-mail, mobile fields must be filled in this method and vice versa.

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 PATCH 'https://api.serasaexperian.com.br/security/iam/v1/user-identities/me' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userEmail": "string",
    "userMobile": {
        "regionCode": 55,
        "areaCode": 11,
        "phoneNumber": 911112222
    },
    "defaultBusinessId": "string"
}'
Response Response Example
200 - Example 1
{}

Request

Body Params application/json
One of userEmail or userMobile are required
userEmail
string 
optional
userMobile
object (UserMobile) 
optional
regionCode
integer <int32>
required
Example:
55
areaCode
integer <int32>
optional
Required for Brazil region code (code = 55)
Example:
11
phoneNumber
integer <int64>
required
Example:
911112222
defaultBusinessId
string 
optional
Examples

Responses

🟢200OK
application/json
Identity Improved
Body
object {0}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠412412
🔴500Server Error
🔴500Server Error
Modified at 2025-04-11 12:00:41
Previous
Remove Identity
Next
Leverage MFA
Built with