GET//
Retrieve an array of substatuses. This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| account_token string Optional | Unique identifier of the account for which to retrieve substatuses. Send a GET request to /credit/accounts to retrieve existing account tokens.Allowable Values: Existing account token |
| user_token string Optional | Unique identifier of the user for which to retrieve substatuses. Send a GET request to /users to retrieve existing user tokens.Allowable Values: Existing user token |
| is_active boolean Optional | Denotes whether a substatus is active. Allowable Values: true, false |
| substatuses array of strings Optional | Comma-delimited list of substatus types to include. Allowable values: HARDSHIP, FRAUD, MLA, SCRA, DECEASED, BANKRUPTCY, POWER_OF_ATTORNEY, BLOCKED, CEASE_AND_DESIST, OPT_OUTAllowable Values: HARDSHIP, FRAUD, MLA, SCRA, DECEASED, BANKRUPTCY, POWER_OF_ATTORNEY, BLOCKED, CEASE_AND_DESIST, OPT_OUT |
| count integer Optional | The number of resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.Allowable Values: createdTime, -createdTime |
Response body
| Fields | Description |
|---|---|
| count integer Returned | Number of resources returned. Allowable Values: 1-100 |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Returned | Sort order index of the last resource in the returned array. Allowable Values: Any integer |
| is_more boolean Returned | A value of true indicates that more unreturned resources exist.Allowable Values: true, false |
| data array of objects Returned | Contains one or more substatuses. Allowable Values: token, resource_type, resource_token, substatus, state, is_active, attributes, created_time, updated_time, events. |
| data[].token string Returned | Unique identifier of the credit substatus. Allowable Values: 36 char max |
| data[].resource_type string Returned | Type of resource to which the substatus is applied. Allowable Values: ACCOUNT, USER, BUSINESS |
| data[].resource_token string Returned | Unique identifier of the resource. Allowable Values: 36 char max |
| data[].substatus string Returned | Type of substatus. Allowable Values: 36 char max - HARDSHIP- FRAUD- MLA- SCRA- DECEASED- BANKRUPTCY- POWER_OF_ATTORNEY- BLOCKED- CEASE_AND_DESIST- OPT_OUT |
| data[].state string Returned | Current state of the substatus. Allowable Values: ACTIVE, INACTIVE, DECEASED_REPORTED, DECEASED_CONFIRMED, FRAUD_REPORTED, FRAUD_CONFIRMED, BANKRUPTCY_FILED, BANKRUPTCY_WITHDRAWN, BANKRUPTCY_REAFFIRMED, BANKRUPTCY_REAFFIRM_RESCINDED, BANKRUPTCY_DISCHARGED, BANKRUPTCY_DISMISSED, BANKRUPTCY_FILED_INACTIVE, BANKRUPTCY_WITHDRAWN_INACTIVE, BANKRUPTCY_REAFFIRMED_INACTIVE, BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE, BANKRUPTCY_DISCHARGED_INACTIVE, BANKRUPTCY_DISMISSED_INACTIVE |
| data[].is_active boolean Returned | Denotes whether a substatus is active. Allowable Values: true, false |
| data[].attributes array of objects Conditionally returned | Additional dynamic attributes related to the substatus. If the substatus is BANKRUPTCY, SCRA, or POWER_OF_ATTORNEY, then attributes are present.Allowable Values: key, value |
| data[].attributes[].key string Conditionally returned | The name of the attribute. Marqeta provides several preconfigured attributes, as described in the following list. - chapter: If the substatus is BANKRUPTCY, then this value defines the chapter.- military_start_date: If the substatus is SCRA, then this value defines the military start date.- end_date: If the substatus is POWER_OF_ATTORNEY, then the end date attribute is present. This specifies the date when the power of attorney document is no longer valid.- poa_details: If the substatus is POWER_OF_ATTORNEY, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is UNRESTRICTED.- agent_name: If the substatus is POWER_OF_ATTORNEY, then the agent name is present. This attribute specifies the name of the agent with Power of Attorney for the user.- agent_address: If the substatus is POWER_OF_ATTORNEY, then the agent address attribute is present. This attribute specifies the address of the agent with Power of Attorney for the user.- agent_id_type: If the substatus is POWER_OF_ATTORNEY, then the agent identification type attribute is present. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user.- agent_id_value: If the substatus is POWER_OF_ATTORNEY, then the agent identification value attribute is present. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user.- agent_id_expiration_date: If the substatus is POWER_OF_ATTORNEY, then the attribute for the Power of Attorney identification expiration date attribute is present. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user.Allowable Values: - chapter- military_start_date- end_date- poa_details- agent_name- agent_address- agent_id_type- agent_id_value- agent_id_expiration_date |
| data[].attributes[].value string Conditionally returned | The value of the attribute. Allowable Values: - chapter: CHAPTER_7, CHAPTER_11, CHAPTER_12, CHAPTER_13- military_start_date: yyyy-MM-ddThh:mm:ssZ format - end_date: yyyy-MM-ddThh:mm:ssZ format - poa_details: string (255 char max) - agent_name: string (255 char max) - agent_address: string (255 char max) - agent_id_type: SSN, TIN, SIN, NIN, PASSPORT_NUMBER, DRIVERS_LICENSE, BUSINESS_LICENSE, BUSINESS_NUMBER, BUSINESS_TAX_ID, TAXPAYER_REFERENCE- agent_id_value: string (255 char max) - agent_id_expiration_date: yyyy-MM-ddThh:mm:ssZ format |
| data[].created_time datetime Conditionally returned | Date and time when the substatus was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].updated_time datetime Conditionally returned | Date and time when the substatus was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].events array of objects Conditionally returned | List of events related to the substatus. Allowable Values: Valid array of one or more substatus events |
| data[].events[].state string Returned | The state of the event. Allowable Values: ACTIVE, INACTIVE, DECEASED_REPORTED, DECEASED_CONFIRMED, FRAUD_REPORTED, FRAUD_CONFIRMED, BANKRUPTCY_FILED, BANKRUPTCY_WITHDRAWN, BANKRUPTCY_REAFFIRMED, BANKRUPTCY_REAFFIRM_RESCINDED, BANKRUPTCY_DISCHARGED, BANKRUPTCY_DISMISSED, BANKRUPTCY_FILED_INACTIVE, BANKRUPTCY_WITHDRAWN_INACTIVE, BANKRUPTCY_REAFFIRMED_INACTIVE, BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE, BANKRUPTCY_DISCHARGED_INACTIVE, BANKRUPTCY_DISMISSED_INACTIVE |
| data[].events[].channel string Returned | The channel through which the event occurred. Allowable Values: ADMIN, API, FRAUD, SYSTEM |
| data[].events[].reason string Conditionally returned | Reason for the event. Allowable Values: 255 char max |
| data[].events[].effective_date datetime Returned | Effective date of the event, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].events[].created_time datetime Returned | Creation time of the event. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |