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

Login user

Prod Env
https://api.serasaexperian.com.br
Prod Env
https://api.serasaexperian.com.br
POST
https://api.serasaexperian.com.br
/security/iam/v1/user-identities/login

Responsibilities#

Receives credentials and client token to log in a user.

Usage#

Response 201 will have a JWT with an user access token and a refresh token (if user secected remember-me option). Note, if user selected remember-me option, the user access token has a 10 minutes expire time. If not, user access token has 30 minutes expire.

Requirements#

To access this endpoint, the client (application) must have one of the following sets of roles:
CLI-AUTH-IDENTIFIED and CLI-1STPARTY
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.serasaexperian.com.br/security/iam/v1/user-identities/login?clientId&remember-me' \
--header 'Content-Type: application/json' \
--data-raw '{
    "deviceTokenId": "string",
    "deviceId": "string",
    "deviceVersion": "V1"
}'
Response Response Example
200 - Example 1
[
    {
        "code": "01",
        "message": "message reference code error"
    }
]

Request

Query Params
clientId
string 
required
Client ID
remember-me
boolean 
required
Remeber-me selected option
Header Params
ip
string 
optional
IP from origin
Body Params application/json
deviceTokenId
string 
optional
deviceId
string 
optional
deviceVersion
enum<string> 
optional
Allowed values:
V1V2
Default:
V1
Examples

Responses

🟢200OK
application/json
Unexpected Error
Body
array of:
code
string 
required
Code error.
Example:
01
message
string 
required
Return message reference code error.
Example:
message reference code error
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🔴500Server Error
Modified at 2025-04-11 12:46:35
Previous
User identification
Next
Login legacy user
Built with