GET///
Retrieve a user or account substatus.
URL path parameters
| Fields | Description |
|---|---|
| substatus_token string Required | Unique identifier of the substatus to retrieve. Send a GET request to /credit/substatuses to retrieve existing substatus tokens.Allowable Values: Existing substatus token |
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the credit substatus. Allowable Values: 36 char max |
| resource_type string Returned | Type of resource to which the substatus is applied. Allowable Values: ACCOUNT, USER, BUSINESS |
| resource_token string Returned | Unique identifier of the resource. Allowable Values: 36 char max |
| 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 |
| 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 |
| is_active boolean Returned | Denotes whether a substatus is active. Allowable Values: true, false |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| events array of objects Conditionally returned | List of events related to the substatus. Allowable Values: Valid array of one or more substatus events |
| 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 |
| events[].channel string Returned | The channel through which the event occurred. Allowable Values: ADMIN, API, FRAUD, SYSTEM |
| events[].reason string Conditionally returned | Reason for the event. Allowable Values: 255 char max |
| events[].effective_date datetime Returned | Effective date of the event, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| events[].created_time datetime Returned | Creation time of the event. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "substatus_token",
"resource_type": "USER",
"resource_token": "my_user_token",
"substatus": "SCRA",
"state": "ACTIVE",
"is_active": true,
"attributes": [
{
"key": "military_start_date",
"value": "2024-04-02T11:23:23Z"
}
],
"created_time": "2024-04-02T11:23:23Z",
"updated_time": "2024-04-02T11:23:23Z",
"events": [
{
"state": "ACTIVE",
"channel": "ADMIN",
"reason": "Documents submitted and verified",
"effective_date": "2024-04-02T11:23:23Z",
"created_time": "2024-04-02T11:23:23Z"
}
]
}