- Send one time code.
Takes a user ID and returns a temporary token that can be exchanged for a real auth token.
Change password
Get all permissions for the requesting user
End login session, invalidating current login token.
Exchange username and password for JWT token
Exchange current token for a new one
Create a short-lived token
Get logged-in user's info.
SAML callback endpoint
Display IdP setup help
Redirect to the SAML login endpoint
Display Peach SP Metadata
End login session, invalidating current login token.
Exchange username and password for JWT token
Exchange current token for a new one
Replace user's auth based on configured company auth type
Send one time code.
Send a one time code to a phone number or email address. For phone numbers, the code can be sent via text or voice.
The channel via which to send the one time code through.
Enum:"email""text""voice"
Template specific properties to substitute in the corresponding ConfirmationCode template.
Either an email address or phone number.
If the specified channel is text or voice, or the auth type for the specified userType is oneTimeCodeText, then this must be a valid phone number. Otherwise, it must be a valid email address.
This username is used to look up the user in the system.
For agents:
- If the user belongs to an agent, then the given
usernameis used directly as the recipient email address or phone number to text or call with the one time code.
For borrowers:
- If the user belongs to a borrower of type
business, then the givenusernameis used directly as the recipient email address or phone number to text or call with the one time code. - If the user belongs to a borrower of type
person, then borrower's primary contact withaffiliation=selfis selected. And that value is used as the recipient email address or phone number to text or call with the one time code.
POST
curl -i -X POST \
'https://sandboxapi.peach.finance/api/companies/{companyId}/auth/send-one-time-code' \
-H 'Content-Type: application/json' \
-d '{
"channel": "email",
"context": {},
"force": false,
"userType": "agent",
"username": "string"
}'