Find Borrower User Account (Token)

The Find Borrower User Account (Token) API gets information about a user account. This can be helpful if you want to check certain information about their account, including the following properties:

  • id, which is their Borrower Account ID.
  • borrowerId, which is their Borrower ID.
  • isEmailNotVerified, which is either true or undefined and indicates whether their email is verified.
  • email, which is their email address.
  • phones, which is their phone numbers. deprecated; use phone and isPhoneVerified instead (will be removed in next major version)
  • lastActiveAt, which is when they were last active.
  • status, which is one of (active, blocked, pending).
  • testing, which is boolean flag of the Lending System mode.
  • isMfaIncomplete, which is either true or undefined and indicates whether their phone is verified.
  • phone, optional, string.
  • isPhoneVerified, boolean, either true or false.

This API does not require a JSON body.

The header contains two fields encoded in the x-digifi-account JSON base64 string: isEmailNotVerified and isMfaIncomplete. These will either be true or undefined (no falsy value). Check these flags to optionally enforce phone authentication or email verification.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!