POST//
Create a new substatus for a credit account, user, or business.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the credit substatus. Allowable Values: 36 char max |
| substatus string Required | Type of substatus. - HARDSHIP, FRAUD, CEASE_AND_DESIST, BLOCKED, and OPT_OUT can only be applied to the ACCOUNT resource type.- MLA, SCRA and DECEASED can only be applied to the USER resource type.- POWER_OF_ATTORNEY and BANKRUPTCY can be applied to either the USER or the BUSINESS resource type.Allowable Values: 1–36 chars HARDSHIP, FRAUD, MLA, SCRA, DECEASED, POWER_OF_ATTORNEY, CEASE_AND_DESIST, OPT_OUT, BANKRUPTCY, BLOCKED |
| resource_type string Required | Type of resource to which the substatus can be applied. Allowable Values: USER, ACCOUNT, BUSINESS |
| resource_token string Required | Unique identifier of the user or account or business for which you want to create a substatus. - Send a GET request to /credit/accounts to retrieve existing account tokens.- Send a GET request to /users to retrieve existing user tokens.- Send a GET request to /business to retrieve existing business tokens.Allowable Values: 1–36 chars |
| attributes array of objects Optional | Additional dynamic attributes related to the substatus. If the substatus is BANKRUPTCY, SCRA or POWER_OF_ATTORNEY, then attributes are required.Allowable Values: key, value |
| attributes[].key string Optional | The name of the attribute. Marqeta provides several preconfigured attributes, as described in the following list. - chapter: If the substatus is BANKRUPTCY, then the chapter attribute is required. CHAPTER_9 is not applicable to a USER resource type. CHAPTER_13 is not applicable to a BUSINESS resource type.- military_start_date: If the substatus is SCRA, then the military_start_date attribute is required. The 6% APR override is applied from the date and time of account opening and continues for the life of the account. It does not end when the substatus is deactivated, and remains in effect until the account is closed. - end_date: If the substatus is POWER_OF_ATTORNEY, then the end date attribute is applicable. 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 required. 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 required. 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 required. 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 required. 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 required. 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 Optional | The value of the attribute. Allowable Values: - chapter: CHAPTER_7, CHAPTER_9, 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 |
| events array of objects Required | List of events related to the substatus. Allowable Values: Valid array of one or more substatus events |
| events[].state string Required | Initial state of the substatus. - ACTIVE - Required if the substatus is HARDSHIP, MLA, SCRA, DECEASED, BLOCKED, CEASE_AND_DESIST, OPT_OUT, or POWER_OF_ATTORNEY.- BANKRUPTCY_FILED - Required if the substatus is BANKRUPTCY.- DECEASED_REPORTED - Required if the substatus is DECEASED.- FRAUD_REPORTED - Required if the substatus is FRAUD.Allowable Values: ACTIVE, BANKRUPTCY_FILED, DECEASED_REPORTED, FRAUD_REPORTED |
| events[].channel string Optional | The mechanism by which the state of the substatus was applied. - ADMIN - Indicates that the state of the substatus was added through the Marqeta Dashboard.- API - Indicates that you initiated an update of the substatus through the Core API. Use this value when creating a substatus.- FRAUD - Indicates that either Marqeta or the card network has determined that the account is fraudulent.- SYSTEM - Indicates that Marqeta initiated the state of the substatus. For example, Marqeta determined during application decisioning that the applicant is MLA.Allowable Values: ADMIN, API, FRAUD, SYSTEMDefault value: API |
| events[].reason string Optional | Reason for applying a state designation to the substatus. Allowable Values: 255 char max |
| events[].effective_date datetime Optional | Date and time when the state of the substatus went into effect, in UTC. The effective date must be in the past. If no value is set, then the effective date and time will be the current time. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample request body
JSON
{
"resource_type": "USER",
"resource_token": "my_user_token",
"substatus": "SCRA",
"attributes": [
{
"key": "military_start_date",
"value": "2024-04-02T11:23:23Z"
}
],
"events": [
{
"state": "ACTIVE",
"channel": "ADMIN",
"reason": "Documents submitted and verified"
}
]
}
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-05-17T21:50:13.729Z",
"updated_time": "2024-05-17T21:51:39.774Z",
"events": [
{
"state": "ACTIVE",
"channel": "ADMIN",
"reason": "Documents submitted and verified",
"effective_date": "2024-05-17T21:50:13.738Z",
"created_time": "2024-05-17T21:50:13.740Z"
}
]
}