Skip to main content

Nexus API

MFA credentials

Best practice is to use the list member challenges endpoint to list challenges that need to be answered; however, MX continues to support partners who use the mfa credentials endpoint for this purpose.
Institutions often require MFA (multi-factor authentication) in order to refresh a member. This form of authentication is typically a question/answer about the user - similar to "Where did you go to high school?" or "Where would you like an authentication token to be sent?".
In the event that we do not have the answer to the question being asked by the institution, the aggregation job will be returned with a "CHALLENGED" status. This will require the user to answer the mfa question(s) to aggregate the member.
This endpoint will return the credentials that need to be created (questions that need to be answered) to aggregate the member.

GET
/jobs/{job_guid}/mfa_credentials

Path Parameters

FieldRequiredType

job_guid

The unique identifier for the job. Defined by MX.

Required
String
Loading...