New implementations shouldn’t use this endpoint. It’s maintained for compatibility with our Nexus API only.
Jobs Fields
| Field | Data Type | Description |
|---|---|---|
created_at | String | Date and time the job was created, in ISO 8601 format with timestamp. |
error_message | String | If the job returns an error, this field contains the error message. |
finished_at | String | Date and time the job finished, in ISO 8601 format with timestamp. |
guid | String | Unique identifier for the job. Defined by MX. |
institution_guid | String | Unique identifier for the institution the job is attached to. Defined by MX. |
is_authenticated | Boolean | If the member’s credentials have been authenticated this field is true. Otherwise, this field is false. |
member_guid | String | Unique identifier for the member the job is attached to. Defined by MX. |
started_at | String | Date and time the job started, in ISO 8601 format with timestamp. |
status | Integer | The status of the job. See Job Status for more information. |
status_name | String | The name of the job status. See Job Status for more information. |
updated_at | String | Date and time the job was updated, in ISO 8601 format with timestamp. |
user_guid | String | Unique identifier for the user the job is attached to. Defined by MX. |
Job Status
MX has introduced member connection statuses to provide more information about the state of an aggregation attempt. Use member connection statuses as the main source of information for adjudicating and addressing aggregation issues and are intended to replace job statuses, which will soon be deprecated.
status field returns an integer. The status_name field returns a string. See the table below for the meaning of each status.
| Status | Definition |
|---|---|
| 0 | INITIATED: Refresh request initiated |
| 1 | REQUESTED: Refresh requested |
| 2 | CHALLENGED: During authentication, an MFA credential is missing or incorrect. See the mfa_credentials property to identify missing credentials. After resolving member credentials, use the refresh individual member or refresh all members endpoint to retry the refresh. |
| 3 | RECEIVED: Refresh results returned from the member’s institution, pending processing by MX |
| 4 | TRANSFERRED: Transferred internally within the MX platform |
| 5 | PROCESSED: Refresh data processed by MX, pending publication to the API |
| 6 | COMPLETED: Refresh data available in the API |
| 7 | PREVENTED: Refresh blocked due to excessive failed login attempts |
| 8 | DENIED: Authentication failed (invalid credentials or MFA response) |
| 9 | HALTED: Non-authentication exception in the MX refresh platform |