Applications - Marqeta Docs

Marqeta’s credit platform’s credit applications feature enables you to create and manage credit account applications and retrieve disclosures that you can show to an applicant during the application process. To receive webhook notifications when application transition events occur, see Credit application transition events in Event Types.

Create application

Action: POST
Endpoint: /credit/applications Create a new application.

Request body

Name	Type	Required?	Description	Allowable Values
token	string	Optional	Unique identifier of the application.	36 char max
type	string	Optional	Type of application.	`CREDIT_DECISION`, `PREQUALIFICATION`
user_token	string	Required	Unique identifier of the applicant, the user applying for a credit account.	36 char max
bundle_token	string	Required	Unique identifier of the bundle associated with the application.	36 char max
soct_tracking_token	string	Required	The tracking token of the Summary of Credit Terms (SOCT). This is the `tracking_token` returned in the `SOCT` object when sending a `GET` request to the `/credit/applications/files` endpoint before a decision on the application is made.	36 char max
privacy_policy_tracking_token	string	Required	The tracking token of the Privacy Policy. This is the `tracking_token` returned in the `PRIVACY_POLICY` object when sending a `GET` request to the `/credit/applications/files` endpoint before a decision on the application is made.	36 char max
e_disclosure_tracking_token	string	Required	The tracking token of the eDisclosure. This is the `tracking_token` returned in the `E_DISCLOSURE` object when sending a `GET` request to the `/credit/applications/files` endpoint before a decision on the application is made.	36 char max
rewards_disclosure_pre_terms_tracking_token	string	Optional	The tracking token of the Rewards Disclosure Pre-terms. This is the `tracking_token` returned in the `REWARDS_DISCLOSURE_PRE_TERMS` object when sending a `GET` request to the `/credit/applications/files` endpoint before a decision on the application is made.	36 char max
prequalified_offer_pre_terms_tracking_token	string	Optional	The tracking token of the Pre-qualified Offer Pre-Terms. This is the `tracking_token` returned in the `PREQUALIFICATION_PRE_TERMS` object when sending a `GET` request to the `/credit/applications/files` endpoint before a decision on the application is made.	36 char max
residence_type	string	Required	Whether the user owns or rents their residence, or has another situation. Required when retrieving an application.	`OWN`, `RENT`, `OTHER`
monthly_mortgage_or_rent	decimal	Required	Monthly amount of the mortgage or rent that the user currently pays. Required when retrieving an application.	0–99999.99
total_annual_income	decimal	Required	The total amount of the user’s annual income. Required when retrieving an application.	0–99999999.99
primary_income_source	string	Required	Whether the primary income source comes from the user being employed, unemployed, self-employment, or another situation. Required when retrieving an application.	`EMPLOYED`, `UNEMPLOYED`, `SELF_EMPLOYED`, `OTHER`
any_non_taxable_income	boolean	Required	A value of `true` indicates that the user has a non-taxable income source. Required when retrieving an application.	`true`, `false`
device_data	object	Optional	Contains information on user’s device fingerprint. Usually obtained through a component embedded in the application. Required if application `type` is `PREQUALIFICATION`.	Existing `device_data` object
device_data.provider	string	Optional	The provider of the embedded component.	`IOVATION`
device_data.data	string	Optional	The data generated by the embedded component.	Example: `{ ipv4: "1.1.1.1", fingerprint: "abcdef0123456789"}`
meta_data	object	Optional	Customer-defined additional information about the application.	You can define the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`
offer_id	string	Optional	Unique identifier of the offer for a pre-screened applicant.	36 char max

Sample request body

JSON

{
  "token": "application_token_1111",
  "user_token": "user_token_1111",
  "bundle_token": "bundle_token_1111",
  "soct_tracking_token": "tracking_token_HAiOjE2Y1Nri3fPDg",
  "privacy_policy_tracking_token": "tracking_token_ImlzcyI6ImxJQ1k",
  "e_disclosure_tracking_token": "tracking_token_X3NoybmxsEtQ0mZ",
  "rewards_disclosure_pre_terms_tracking_token": "tracking_token_ZjNmZ0MzIyNDYs",
  "prequalified_offer_pre_terms_tracking_token": "tracking_token_D0VufJpbGZhdC",
  "residence_type": "OWN",
  "monthly_mortgage_or_rent": 1200,
  "total_annual_income": 95000,
  "primary_income_source": "SELF_EMPLOYED",
  "any_non_taxable_income": false
}

Response body

Name	Type	Required?	Description	Allowable Values
token	string	Returned	Unique identifier of the application.	36 char max
type	string	Returned	Type of application.	`CREDIT_DECISION`, `PREQUALIFICATION`
state	string	Returned	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`
user_token	string	Returned	Unique identifier of the applicant, the user applying for a credit account.	36 char max
bundle_token	string	Returned	Unique identifier of the bundle associated with the application.	36 char max
account_token	string	Conditionally returned	Unique identifier of the credit account for which the user is applying. Returned when retrieving an application in the `APPROVED` state.	36 char max
residence_type	string	Conditionally returned	Whether the user owns or rents their residence, or has another situation.	`OWN`, `RENT`, `OTHER`
monthly_mortgage_or_rent	decimal	Conditionally returned	Monthly amount of the mortgage or rent that the user currently pays.	Format: 0.00
total_annual_income	decimal	Conditionally returned	The total amount of the user’s annual income.	Format: 0.00
primary_income_source	string	Conditionally returned	Whether the primary income source comes from the user being employed, unemployed, self-employment, or another situation.	`EMPLOYED`, `UNEMPLOYED`, `SELF_EMPLOYED`, `OTHER`
any_non_taxable_income	boolean	Conditionally returned	A value of `true` indicates that the user has a non-taxable income source.	`true`, `false`
decision_token	string	Conditionally returned	Unique identifier of the decision made on the application.	36 char max
decision_model	object	Conditionally returned	Contains information on the decision model returned by the issuing bank if a decision has been rendered. Returned when retrieving an application after a decision has been rendered.	Valid `decision_model` object
decision_model.decision_date	datetime	Conditionally returned	Date and time when the decision on the application was rendered, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
decision_model.credit_limit	integer	Conditionally returned	The maximum line of credit extended to the user, also the maximum balance the credit account can carry.	Any integer
decision_model.purchase_apr	decimal	Conditionally returned	The purchase APR approved for the user.	Format: 0.00
decision_model.prime_rate	decimal	Conditionally returned	The current prime rate set by the Fed.	Format: 0.00
decision_model.margin	decimal	Conditionally returned	Number of percentage points added to the prime rate, used to calculate the purchase APR.	Format: 0.00
decision_model.card_product_level	string	Conditionally returned	The tier of the card product.	`PREMIUM`, `TRADITIONAL`
decision_model.received_best_rate	boolean	Conditionally returned	A value of `true` indicates that the user received the credit product’s best APR. If `false`, you must display to the user the following: `score_factors`, `credit_score`, `credit_score_date`, `credit_bureau`, `score_range`.	`true`, `false`
decision_model.score_factors	array of strings	Conditionally returned	Factors that the bureau used to determine the user’s credit score.	Example: `[
decision_model.credit_score	integer	Conditionally returned	The user’s credit score.	A valid credit score
decision_model.credit_score_date	date	Conditionally returned	Date and time when the credit score went into effect.	Format: yyyy-MM-dd
decision_model.score_range	string	Conditionally returned	The range in which the user’s credit score falls.	64 char max
decision_model.created_date	datetime	Conditionally returned	Date and time when the decision model was created on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
decision_model.denial_reasons	array of strings	Conditionally returned	An array of reasons that explain why the application was declined.	Example: `[
decision_model.adverse_action_template_code	string	Conditionally returned	Indicates the version of the Notice of Adverse Action (NOAA) template used. Can have these possible values: `AA0` - score denial with score disclosure `AA1` - individual reason with score disclosure `AA2` - individual reason without score disclosure `AA3` - locked and frozen * `AA4` - fraud related	`AA0`, `AA1`, `AA2`, `AA3`, `AA4`
decision_model.credit_bureau	object	Conditionally returned	Contains information on the credit bureau.	Existing `credit_bureau` object.
decision_model.credit_bureau.name	string	Returned	Name of the credit bureau used to obtain the user’s credit data.	`EXPERIAN`, `EQUIFAX`, `TransUnion Customer Relations`
decision_model.credit_bureau.address	object	Returned	Contains information on the address of the credit bureau.	Existing `address` object.
decision_model.credit_bureau.address.address1	string	Returned	Street address.	255 char max
decision_model.credit_bureau.address.address2	string	Conditionally returned	Additional address information.	255 char max
decision_model.credit_bureau.address.city	string	Returned	Address city.	255 char max
decision_model.credit_bureau.address.state	string	Returned	Address state.	255 char max
decision_model.credit_bureau.address.zip	string	Returned	Address ZIP code.	255 char max
decision_model.credit_bureau.phone_number	string	Returned	Phone number of the credit bureau.	Example: 5555555555
decision_model.credit_bureau.website	string	Returned	Website of the credit bureau.	A valid URL
decision_model.expire_date	date	Conditionally returned	Date when the decision model expires.	Format: yyyy-MM-dd
decision_model.token	string	Conditionally returned	Unique identifier of the decision model. See `decision_model.status` for the current state of the application.	64 char max
decision_model.user_token	string	Conditionally returned	Unique identifier of the applicant, the user applying for a credit account.	64 char max
decision_model.application_token	string	Conditionally returned	Unique identifier of the application.	64 char max
decision_model.submitted_date_time	datetime	Conditionally returned	Date and time when the decision was submitted, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
decision_model.decision_id	string	Conditionally returned	Unique identifier of the decision made based on the decision model. See `decision_model.status` for the current state of the application.	64 char max
decision_model.status	string	Conditionally returned	Status of the decision on the application.	`SUBMITTED`, `DECISIONING`, `MANUAL_REVIEW`, `APPROVED`, `DECLINED`, `EXPIRED`, `REJECTED`, `ERROR`
soct_accepted_at	datetime	Returned	Date and time when Marqeta accepted the Summary of Credit Terms (SOCT), in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
e_disclosure_accepted_at	datetime	Returned	Date and time when Marqeta accepted the e-Disclosure, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
prequalified_offer_pre_terms_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Pre-qualified Offer Pre-terms, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
rewards_disclosure_pre_terms_accepted_at	datetime	Returned	Date and time when Marqeta accepted the Rewards Disclosure, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
privacy_policy_accepted_at	datetime	Returned	Date and time when Marqeta accepted the Privacy Policy, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
card_membership_agreement_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Card Membership Agreement, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
term_schedule_information_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Terms Schedule, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
benefits_disclosure_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Benefits Disclosure, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
rewards_disclosure_post_terms_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Rewards Disclosure, in UTC. Returned if the user accepted their approved application.	yyyy-MM-ddThh:mm:ssZ
created_date	datetime	Returned	Date and time when the application was created on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
updated_date	datetime	Returned	Date and time when the application was last updated on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
application_accepted_at	datetime	Conditionally returned	Date and time when the application was accepted on the Marqeta platform, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
application_canceled_at	datetime	Conditionally returned	Date and time when the application was canceled on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
device_data	object	Conditionally returned	Contains information on user’s device fingerprint. Usually obtained through a component embedded in the application. Required if application `type` is `PREQUALIFICATION`.	Existing `device_data` object
device_data.provider	string	Conditionally returned	The provider of the embedded component.	`IOVATION`
device_data.data	string	Conditionally returned	The data generated by the embedded component.	Example: `{ ipv4: "1.1.1.1", fingerprint: "abcdef0123456789"}`
error_details	object	Conditionally returned	Contains details on an application error.	Existing `error_details` object
error_details.token	string	Returned	Unique identifier of the error details.	36 char max
error_details.application_token	string	Returned	Unique identifier of the application that resulted in an error.	36 char max
error_details.type	string	Returned	Type of error.	`VALIDATION`, `TIMEOUT`, `UPSTREAM`, `DOWNSTREAM`, `UNKNOWN`
error_details.message	string	Returned	Message describing the error.	255 char max
meta_data	object	Conditionally returned	Customer-defined additional information about the application.	You can define the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`
offer_id	string	Conditionally returned	Unique identifier of the offer for a pre-screened applicant.	36 char max

Sample response body

JSON

{
  "token": "application_token_1111",
  "type": "CREDIT_DECISION",
  "state": "CREATED",
  "user_token": "user_token_1111",
  "bundle_token": "bundle_token_1111",
  "account_token": "account_token_1111",
  "residence_type": "OWN",
  "monthly_mortgage_or_rent": 1200,
  "total_annual_income": 95000,
  "primary_income_source": "SELF_EMPLOYED",
  "any_non_taxable_income": false,
  "decision_token": "decision_token_1111",
  "soct_accepted_at": "2022-07-07T19:47:46.181Z",
  "e_disclosure_accepted_at": "2022-07-07T19:47:46.184Z",
  "rewards_disclosure_pre_terms_accepted_at": "2022-07-07T19:47:46.187Z",
  "privacy_policy_accepted_at": "2022-07-07T19:47:46.188Z",
  "created_date": "2022-07-07T19:47:46.268Z",
  "updated_date": "2022-07-07T19:47:46.268Z"
}

Retrieve application

Action: GET
Endpoint: /credit/applications/{token} Retrieve a specific application.

URL path parameters

Name	Type	Required?	Description	Allowable Values
token	string	Required	Unique identifier of the application to retrieve.	Existing application token

URL query parameters

Name	Type	Required?	Description	Allowable Values
expand	array of strings	Optional	Embeds the specified object into the response.	`DEVICE_DATA`, `INCLUDE_DECISION`, `INCLUDE_ERROR`

Response body

Name	Type	Required?	Description	Allowable Values
token	string	Returned	Unique identifier of the application.	36 char max
type	string	Returned	Type of application.	`CREDIT_DECISION`, `PREQUALIFICATION`
state	string	Returned	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`
user_token	string	Returned	Unique identifier of the applicant, the user applying for a credit account.	36 char max
bundle_token	string	Returned	Unique identifier of the bundle associated with the application.	36 char max
account_token	string	Conditionally returned	Unique identifier of the credit account for which the user is applying. Returned when retrieving an application in the `APPROVED` state.	36 char max
residence_type	string	Conditionally returned	Whether the user owns or rents their residence, or has another situation.	`OWN`, `RENT`, `OTHER`
monthly_mortgage_or_rent	decimal	Conditionally returned	Monthly amount of the mortgage or rent that the user currently pays.	Format: 0.00
total_annual_income	decimal	Conditionally returned	The total amount of the user’s annual income.	Format: 0.00
primary_income_source	string	Conditionally returned	Whether the primary income source comes from the user being employed, unemployed, self-employment, or another situation.	`EMPLOYED`, `UNEMPLOYED`, `SELF_EMPLOYED`, `OTHER`
any_non_taxable_income	boolean	Conditionally returned	A value of `true` indicates that the user has a non-taxable income source.	`true`, `false`
decision_token	string	Conditionally returned	Unique identifier of the decision made on the application.	36 char max
decision_model	object	Conditionally returned	Contains information on the decision model returned by the issuing bank if a decision has been rendered. Returned when retrieving an application after a decision has been rendered.	Valid `decision_model` object
decision_model.decision_date	datetime	Conditionally returned	Date and time when the decision on the application was rendered, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
decision_model.credit_limit	integer	Conditionally returned	The maximum line of credit extended to the user, also the maximum balance the credit account can carry.	Any integer
decision_model.purchase_apr	decimal	Conditionally returned	The purchase APR approved for the user.	Format: 0.00
decision_model.prime_rate	decimal	Conditionally returned	The current prime rate set by the Fed.	Format: 0.00
decision_model.margin	decimal	Conditionally returned	Number of percentage points added to the prime rate, used to calculate the purchase APR.	Format: 0.00
decision_model.card_product_level	string	Conditionally returned	The tier of the card product.	`PREMIUM`, `TRADITIONAL`
decision_model.received_best_rate	boolean	Conditionally returned	A value of `true` indicates that the user received the credit product’s best APR. If `false`, you must display to the user the following: `score_factors`, `credit_score`, `credit_score_date`, `credit_bureau`, `score_range`.	`true`, `false`
decision_model.score_factors	array of strings	Conditionally returned	Factors that the bureau used to determine the user’s credit score.	Example: `[
decision_model.credit_score	integer	Conditionally returned	The user’s credit score.	A valid credit score
decision_model.credit_score_date	date	Conditionally returned	Date and time when the credit score went into effect.	Format: yyyy-MM-dd
decision_model.score_range	string	Conditionally returned	The range in which the user’s credit score falls.	64 char max
decision_model.created_date	datetime	Conditionally returned	Date and time when the decision model was created on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
decision_model.denial_reasons	array of strings	Conditionally returned	An array of reasons that explain why the application was declined.	Example: `[
decision_model.adverse_action_template_code	string	Conditionally returned	Indicates the version of the Notice of Adverse Action (NOAA) template used. Can have these possible values: `AA0` - score denial with score disclosure `AA1` - individual reason with score disclosure `AA2` - individual reason without score disclosure `AA3` - locked and frozen * `AA4` - fraud related	`AA0`, `AA1`, `AA2`, `AA3`, `AA4`
decision_model.credit_bureau	object	Conditionally returned	Contains information on the credit bureau.	Existing `credit_bureau` object.
decision_model.credit_bureau.name	string	Returned	Name of the credit bureau used to obtain the user’s credit data.	`EXPERIAN`, `EQUIFAX`, `TransUnion Customer Relations`
decision_model.credit_bureau.address	object	Returned	Contains information on the address of the credit bureau.	Existing `address` object.
decision_model.credit_bureau.address.address1	string	Returned	Street address.	255 char max
decision_model.credit_bureau.address.address2	string	Conditionally returned	Additional address information.	255 char max
decision_model.credit_bureau.address.city	string	Returned	Address city.	255 char max
decision_model.credit_bureau.address.state	string	Returned	Address state.	255 char max
decision_model.credit_bureau.address.zip	string	Returned	Address ZIP code.	255 char max
decision_model.credit_bureau.phone_number	string	Returned	Phone number of the credit bureau.	Example: 5555555555
decision_model.credit_bureau.website	string	Returned	Website of the credit bureau.	A valid URL
decision_model.expire_date	date	Conditionally returned	Date when the decision model expires.	Format: yyyy-MM-dd
decision_model.token	string	Conditionally returned	Unique identifier of the decision model. See `decision_model.status` for the current state of the application.	64 char max
decision_model.user_token	string	Conditionally returned	Unique identifier of the applicant, the user applying for a credit account.	64 char max
decision_model.application_token	string	Conditionally returned	Unique identifier of the application.	64 char max
decision_model.submitted_date_time	datetime	Conditionally returned	Date and time when the decision was submitted, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
decision_model.decision_id	string	Conditionally returned	Unique identifier of the decision made based on the decision model. See `decision_model.status` for the current state of the application.	64 char max
decision_model.status	string	Conditionally returned	Status of the decision on the application.	`SUBMITTED`, `DECISIONING`, `MANUAL_REVIEW`, `APPROVED`, `DECLINED`, `EXPIRED`, `REJECTED`, `ERROR`
soct_accepted_at	datetime	Returned	Date and time when Marqeta accepted the Summary of Credit Terms (SOCT), in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
e_disclosure_accepted_at	datetime	Returned	Date and time when Marqeta accepted the e-Disclosure, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
prequalified_offer_pre_terms_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Pre-qualified Offer Pre-terms, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
rewards_disclosure_pre_terms_accepted_at	datetime	Returned	Date and time when Marqeta accepted the Rewards Disclosure, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
privacy_policy_accepted_at	datetime	Returned	Date and time when Marqeta accepted the Privacy Policy, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
card_membership_agreement_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Card Membership Agreement, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
term_schedule_information_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Terms Schedule, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
benefits_disclosure_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Benefits Disclosure, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
rewards_disclosure_post_terms_accepted_at	datetime	Conditionally returned	Date and time when Marqeta accepted the Rewards Disclosure, in UTC. Returned if the user accepted their approved application.	yyyy-MM-ddThh:mm:ssZ
created_date	datetime	Returned	Date and time when the application was created on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
updated_date	datetime	Returned	Date and time when the application was last updated on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
application_accepted_at	datetime	Conditionally returned	Date and time when the application was accepted on the Marqeta platform, in UTC. Returned if the user accepted their approved application.	Format: yyyy-MM-ddThh:mm:ssZ
application_canceled_at	datetime	Conditionally returned	Date and time when the application was canceled on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ
device_data	object	Conditionally returned	Contains information on user’s device fingerprint. Usually obtained through a component embedded in the application. Required if application `type` is `PREQUALIFICATION`.	Existing `device_data` object
device_data.provider	string	Conditionally returned	The provider of the embedded component.	`IOVATION`
device_data.data	string	Conditionally returned	The data generated by the embedded component.	Example: `{ ipv4: "1.1.1.1", fingerprint: "abcdef0123456789"}`
error_details	object	Conditionally returned	Contains details on an application error.	Existing `error_details` object
error_details.token	string	Returned	Unique identifier of the error details.	36 char max
error_details.application_token	string	Returned	Unique identifier of the application that resulted in an error.	36 char max
error_details.type	string	Returned	Type of error.	`VALIDATION`, `TIMEOUT`, `UPSTREAM`, `DOWNSTREAM`, `UNKNOWN`
error_details.message	string	Returned	Message describing the error.	255 char max
meta_data	object	Conditionally returned	Customer-defined additional information about the application.	You can define the names and values of up to 20 fields in the format `"my_name_1": "my_value_1"`
offer_id	string	Conditionally returned	Unique identifier of the offer for a pre-screened applicant.	36 char max

Sample response body

JSON

{
  "token": "application_token_1111",
  "type": "CREDIT_DECISION",
  "state": "APPROVED",
  "user_token": "user_token_1111",
  "bundle_token": "bundle_token_1111",
  "account_token": "account_token_1111",
  "residence_type": "OWN",
  "monthly_mortgage_or_rent": 1200,
  "total_annual_income": 95000,
  "primary_income_source": "SELF_EMPLOYED",
  "any_non_taxable_income": false,
  "decision_token": "decision_token_1111",
  "decision_model": {
    "decision_date": "2022-07-07T00:00:00Z",
    "credit_limit": 15000,
    "purchase_apr": 23.25,
    "prime_rate": 3.25,
    "margin": 20,
    "card_product_level": "TRADITIONAL",
    "received_best_rate": false,
    "score_factors": [
      "[TOO FEW ACCOUNTS CURRENTLY PAID AS AGREED",
      " LACK OF RECENT INSTALLMENT LOAN INFORMATION",
      " TOO MANY ACCOUNTS WITH BALANCES",
      " LENGTH OF TIME REVOLVING ACCOUNTS HAVE BEEN ESTABLISHED]"
    ],
    "credit_score": 821,
    "credit_score_date": "2022-07-07",
    "score_range": "300-850",
    "created_date": "2022-07-07T19:47:47Z",
    "denial_reasons": [
      "[]"
    ],
    "credit_bureau": {
      "name": "TransUnion Customer Relations",
      "address": {
        "address1": "2 Baldwin Place",
        "address2": "P.O. Box 1000",
        "city": "Chester",
        "state": "PA",
        "zip": "19016"
      },
      "phone_number": "1-800-888-4213",
      "website": "www.transunion.com"
    },
    "token": "b660b53c-0971-4ca2-b2cf-fc8739e860da",
    "user_token": "user_token_1111",
    "application_token": "0467ff1b-798a-492a-a743-f490a3ccd892",
    "submitted_date_time": "2022-07-07T19:47:47Z",
    "decision_id": "ee7325e7-d13e-40db-8498-a784b76adc7d",
    "status": "APPROVED"
  },
  "soct_accepted_at": "2022-07-07T19:47:46Z",
  "e_disclosure_accepted_at": "2022-07-07T19:47:46Z",
  "rewards_disclosure_pre_terms_accepted_at": "2022-07-07T19:47:46Z",
  "privacy_policy_accepted_at": "2022-07-07T19:47:46Z",
  "created_date": "2022-07-07T19:47:46Z",
  "updated_date": "2022-07-07T19:48:16Z"
}

Transition application state

Action: POST
Endpoint: /credit/applications/{token}/transitions Transition the current state of an application to a new state.

URL path parameters

Name	Type	Required?	Description	Allowable Values
token	string	Required	Unique identifier of the application whose state you want to transition.	Existing application token

Request body

Name	Type	Required?	Description	Allowable Values
token	string	Optional	Main identifier of the resource, also used as the idempotency key on the request.	36 char max
terms_schedule_tracking_token	string	Optional	The tracking token of the Terms Schedule. This is the `tracking_token` returned in the `TERMS_SCHEDULE` object when sending a `GET` request to the `/credit/applications/files` endpoint before the user makes a decision on their approved application. Required if transitioning application state to `ACCEPTED`	36 char max
card_member_agreement_tracking_token	string	Optional	The tracking token of the Card Member Agreement. This is the `tracking_token` returned in the `CARD_MEMBER_AGREEMENT` object when sending a `GET` request to the `/credit/applications/files` endpoint before the user makes a decision on their approved application. Required if transitioning application state to `ACCEPTED`	36 char max
benefits_disclosure_tracking_token	string	Optional	The tracking token of the Benefits Disclosure. This is the `tracking_token` returned in the `BENEFITS_DISCLOSURE` object when sending a `GET` request to the `/credit/applications/files` endpoint before the user makes a decision on their approved application. Required if transitioning application state to `ACCEPTED`	36 char max
rewards_disclosure_post_terms_tracking_token	string	Optional	The tracking token of the Rewards Disclosure Post-terms. This is the `tracking_token` returned in the `REWARDS_DISCLOSURE_POST_TERMS` object when sending a `GET` request to the `/credit/applications/files` endpoint before the user makes a decision on their approved application. Required if transitioning application state to `ACCEPTED`	36 char max
application_state	string	Required	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`

Sample request body

JSON

{
  "terms_schedule_tracking_token": "tracking_token_CpkwJCoqzucVnJNwj5BsKC9e5",
  "card_member_agreement_tracking_token": "tracking_token_c1YjY2NjBlOGEiLCJzdGF0Z",
  "benefits_disclosure_tracking_token": "tracking_token_JXRapWJL2BI4EwdNqjBBvpI5",
  "rewards_disclosure_post_terms_tracking_token": "tracking_token_ZjNmZ0MzIyNDYsImlhdCI",
  "application_state": "ACCEPTED"
}

Response body

Name	Type	Required?	Description	Allowable Values
token	string	Conditionally returned	Unique identifier of the transition of an application’s state.	36 char max
application_token	string	Conditionally returned	Unique identifier of the application whose state you transitioned.	36 char max
original_status	string	Conditionally returned	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`
status	string	Conditionally returned	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`
created_time	datetime	Conditionally returned	Date and time when the application changed states on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON

{
  "token": "app_state_transition_token_1111",
  "application_token": "application_token_1111",
  "original_status": "APPROVED",
  "status": "ACCEPTED",
  "created_time": "2019-08-24T14:15:22Z"
}

List application transitions

Action: GET
Endpoint: /credit/applications/{token}/transitions Retrieve an array of transitions on a specific application.

URL path parameters

Name	Type	Required?	Description	Allowable Values
token	string	Required	The unique identifier of the application for which you want to retrieve transitions.	Existing application token

Response body

Name	Type	Required?	Description	Allowable Values
count	integer	Returned	Number of resources to retrieve.	1-100
start_index	integer	Returned	Sort order index of the first resource in the returned array.	Any integer
end_index	integer	Returned	Sort order index of the last resource in the returned array.	Any integer
is_more	boolean	Returned	A value of `true` indicates that more unreturned resources exist.	`true`, `false`
data	array of objects	Returned	An array of application transition objects.	Valid `transition` array
data[].token	string	Conditionally returned	Unique identifier of the transition of an application’s state.	36 char max
data[].application_token	string	Conditionally returned	Unique identifier of the application whose state you transitioned.	36 char max
data[].original_status	string	Conditionally returned	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`
data[].status	string	Conditionally returned	State of the application. If manually transitioning an application state: `application_state` is the state to which you want to transition the application status; must be `ACCEPTED` or `REJECTED`.`original_status` returns the state of the application before it was manually transitioned. * `status` returns the state to which the application was transitioned.	`CREATED`, `DECISIONING`, `MANUAL_REVIEW`, `EXPIRED`, `APPROVED`, `REJECTED`, `ACCEPTED`, `DECLINED`, `ERROR`
data[].created_time	datetime	Conditionally returned	Date and time when the application changed states on the Marqeta platform, in UTC.	Format: yyyy-MM-ddThh:mm:ssZ

List files on a bundle or application

Action: GET
Endpoint: /credit/applications/files Retrieve an array of files on a bundle or application Each top-level object returned in the array contains the fields documented in the response body. The name of each object is its corresponding file type:

BENEFITS_DISCLOSURE
CARD_MEMBER_AGREEMENT
E_DISCLOSURE
NOAA
PRIVACY_POLICY
REWARDS_DISCLOSURE_PRE_TERMS
REWARDS_DISCLOSURE_POST_TERMS
SOCT
TERMS_SCHEDULE

URL query parameters

Name	Type	Required?	Description	Allowable Values
bundle_token	string	Optional	Unique identifier of the bundle whose files you want to retrieve. The following file types are returned with the `bundle_token`: `CARD_MEMBER_AGREEMENT``E_DISCLOSURE``PRIVACY_POLICY``REWARDS_DISCLOSURE_PRE_TERMS``REWARDS_DISCLOSURE_POST_TERMS``SOCT`	Existing bundle token
application_token	string	Optional	Unique identifier of the application whose files you want to retrieve. The following file types are returned with the `application_token`: `BENEFITS_DISCLOSURE``CARD_MEMBER_AGREEMENT``E_DISCLOSURE``NOAA``PRIVACY_POLICY``REWARDS_DISCLOSURE_PRE_TERMS``REWARDS_DISCLOSURE_POST_TERMS``SOCT` * `TERMS_SCHEDULE`	Existing application token

Response body

Name	Type	Required?	Description	Allowable Values
file_type	string	Returned	Type of file. `SOCT` - The Summary of Credit Terms (SOCT), which outlines the interest rates, interest charges, and fees associated with the credit account being offered to the user.`REWARDS_DISCLOSURE_PRE_TERMS` - The Rewards Disclosure Pre-terms, which discloses detailed information about the rewards program on the credit account being offered to the user before a decision is rendered on their application. `REWARDS_DISCLOSURE_POST_TERMS` - The Rewards Disclosure Post-terms, which discloses detailed information about the rewards program on the user’s credit account if their application is approved.`BENEFITS_DISCLOSURE` - The Benefits Disclosure, which which is given to a user if their application is approved and discloses detailed information about the benefits on the user’s credit account. `CARD_MEMBER_AGREEMENT` - The Card Member Agreement, which specifies the terms and conditions of the user’s credit account, including the interest rates, interest charges, fees, minimum payment calculations, and more.`PRIVACY_POLICY` - The Privacy Policy, which explains how the information on the user’s application is collected, handled, and processed. `E_DISCLOSURE` - The eDisclosure, which states that the user has agreed to receive disclosures electronically.`TERMS_SCHEDULE` - The Terms Schedule, which is given to a user if their application is approved and specifies the interest rate details on the user’s credit account. * `NOAA` - The Notice of Adverse Action (NOAA), which is given to a user if their application is declined and informs them of the specific reasons why they were denied a credit account.	`SOCT`, `REWARDS_DISCLOSURE_PRE_TERMS`, `REWARDS_DISCLOSURE_POST_TERMS`, `BENEFITS_DISCLOSURE`, `CARD_MEMBER_AGREEMENT`, `PRIVACY_POLICY`, `E_DISCLOSURE`, `TERMS_SCHEDULE`, `NOAA`
links	object	Returned	Contains links to the file in different formats.	Existing `links` object
links.json	string	Conditionally returned	Link to the JSON version of the file.	A valid URL
links.html	string	Conditionally returned	Link to the HTML version of the file.	A valid URL
links.pdf	string	Conditionally returned	Link to the PDF version of the file.	A valid URL
tracking_token	string	Conditionally returned	Unique identifier used to acknowledge that the file has been disclosed to the applicant. If the file was already disclosed, a null value is returned. NOTE: The tracking token is only valid for 14 calendar days.	255 char max

Sample response body

The following code block shows the files returned on a bundle. The name of each top-level object is its corresponding file type.

JSON

{
  "REWARDS_DISCLOSURE_POST_TERMS": {
    "file_type": "REWARDS_DISCLOSURE_POST_TERMS",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_eyJraWQiOiJtODVlYS1I6I"
  },
  "PRIVACY_POLICY": {
    "file_type": "PRIVACY_POLICY",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_ImlzcyI6ImxJQ1kiLD0VufJ"
  },
  "CARD_MEMBER_AGREEMENT": {
    "file_type": "CARD_MEMBER_AGREEMENT",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_c1YjY2NjBlOGEiLCJzdGF0Z"
  },
  "REWARDS_DISCLOSURE_PRE_TERMS": {
    "file_type": "REWARDS_DISCLOSURE_PRE_TERMS",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_ZjNmZ0MzIyNDYsImlhdCI6M"
  },
  "SOCT": {
    "file_type": "SOCT",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_HAiOjE2Y1NzIyMjYri3fPDg"
  },
  "E_DISCLOSURE": {
    "file_type": "E_DISCLOSURE",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_X3NoybmxnaCIsEtQ0mZpbGZ"
  }
}

The following code block shows the files returned on an application if the application is approved. The name of each top-level object is its corresponding file type.

JSON

{
  "REWARDS_DISCLOSURE_POST_TERMS": {
    "file_type": "REWARDS_DISCLOSURE_POST_TERMS",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_eyJraWQiOiJtODVlYS1I6I"
  },
  "PRIVACY_POLICY": {
    "file_type": "PRIVACY_POLICY",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    }
  },
  "TERMS_SCHEDULE": {
    "file_type": "TERMS_SCHEDULE",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_e4MjgtnaCIsyIJTkciLCJ0e"
  },
  "CARD_MEMBER_AGREEMENT": {
    "file_type": "CARD_MEMBER_AGREEMENT",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_c1YjY2NjBlOGEiLCJzdGF0Z"
  },
  "REWARDS_DISCLOSURE_PRE_TERMS": {
    "file_type": "REWARDS_DISCLOSURE_PRE_TERMS",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    }
  },
  "SOCT": {
    "file_type": "SOCT",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    }
  },
  "BENEFITS_DISCLOSURE": {
    "file_type": "BENEFITS_DISCLOSURE",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    },
    "tracking_token": "tracking_token_yIxO2NvZY4YjEiLCJzi1lNTB"
  },
  "E_DISCLOSURE": {
    "file_type": "E_DISCLOSURE",
    "links": {
      "json": "https://url.com/link_to_json_file",
      "html": "https://url.com/link_to_html_file",
      "pdf": "https://url.com/link_to_pdf_file"
    }
  }
}

Retrieve file on a bundle or application

Action: GET
Endpoint: /credit/applications/files/{type} Retrieve a specific type of file on a bundle or application.

URL path parameters

Name	Type	Required?	Description	Allowable Values
type	string	Required	The type of file to retrieve. `SOCT` - The Summary of Credit Terms (SOCT), which outlines the interest rates, interest charges, and fees associated with the credit account being offered to the user.`REWARDS_DISCLOSURE_PRE_TERMS` - The Rewards Disclosure Pre-terms, which discloses detailed information about the rewards program on the credit account being offered to the user before a decision is rendered on their application. `REWARDS_DISCLOSURE_POST_TERMS` - The Rewards Disclosure Post-terms, which discloses detailed information about the rewards program on the user’s credit account if their application is approved.`BENEFITS_DISCLOSURE` - The Benefits Disclosure, which which is given to a user if their application is approved and discloses detailed information about the benefits on the user’s credit account. `CARD_MEMBER_AGREEMENT` - The Card Member Agreement, which specifies the terms and conditions of the user’s credit account, including the interest rates, interest charges, fees, minimum payment calculations, and more.`PRIVACY_POLICY` - The Privacy Policy, which explains how the information on the user’s application is collected, handled, and processed. `E_DISCLOSURE` - The eDisclosure, which states that the user has agreed to receive disclosures electronically.`TERMS_SCHEDULE` - The Terms Schedule, which is given to a user if their application is approved and specifies the interest rate details on the user’s credit account. * `NOAA` - The Notice of Adverse Action (NOAA), which is given to a user if their application is declined and informs them of the specific reasons why they were denied a credit account.	`SOCT`, `REWARDS_DISCLOSURE_PRE_TERMS`, `REWARDS_DISCLOSURE_POST_TERMS`, `BENEFITS_DISCLOSURE`, `CARD_MEMBER_AGREEMENT`, `PRIVACY_POLICY`, `E_DISCLOSURE`, `TERMS_SCHEDULE`, `NOAA`

URL query parameters

Name	Type	Required?	Description	Allowable Values
bundle_token	string	Optional	Unique identifier of the bundle on which you want to retrieve a file. Required if retrieving one of the following file types: `CARD_MEMBER_AGREEMENT``E_DISCLOSURE``PRIVACY_POLICY``REWARDS_DISCLOSURE_PRE_TERMS``REWARDS_DISCLOSURE_POST_TERMS``SOCT`	Existing bundle token
application_token	string	Optional	Unique identifier of the application on which you want to retrieve a file. Required if retrieving one of the following files: `BENEFITS_DISCLOSURE``NOAA` * `TERMS_SCHEDULE`	Existing application token

Response body

Name	Type	Required?	Description	Allowable Values
file_type	string	Returned	Type of file. `SOCT` - The Summary of Credit Terms (SOCT), which outlines the interest rates, interest charges, and fees associated with the credit account being offered to the user.`REWARDS_DISCLOSURE_PRE_TERMS` - The Rewards Disclosure Pre-terms, which discloses detailed information about the rewards program on the credit account being offered to the user before a decision is rendered on their application. `REWARDS_DISCLOSURE_POST_TERMS` - The Rewards Disclosure Post-terms, which discloses detailed information about the rewards program on the user’s credit account if their application is approved.`BENEFITS_DISCLOSURE` - The Benefits Disclosure, which which is given to a user if their application is approved and discloses detailed information about the benefits on the user’s credit account. `CARD_MEMBER_AGREEMENT` - The Card Member Agreement, which specifies the terms and conditions of the user’s credit account, including the interest rates, interest charges, fees, minimum payment calculations, and more.`PRIVACY_POLICY` - The Privacy Policy, which explains how the information on the user’s application is collected, handled, and processed. `E_DISCLOSURE` - The eDisclosure, which states that the user has agreed to receive disclosures electronically.`TERMS_SCHEDULE` - The Terms Schedule, which is given to a user if their application is approved and specifies the interest rate details on the user’s credit account. * `NOAA` - The Notice of Adverse Action (NOAA), which is given to a user if their application is declined and informs them of the specific reasons why they were denied a credit account.	`SOCT`, `REWARDS_DISCLOSURE_PRE_TERMS`, `REWARDS_DISCLOSURE_POST_TERMS`, `BENEFITS_DISCLOSURE`, `CARD_MEMBER_AGREEMENT`, `PRIVACY_POLICY`, `E_DISCLOSURE`, `TERMS_SCHEDULE`, `NOAA`
links	object	Returned	Contains links to the file in different formats.	Existing `links` object
links.json	string	Conditionally returned	Link to the JSON version of the file.	A valid URL
links.html	string	Conditionally returned	Link to the HTML version of the file.	A valid URL
links.pdf	string	Conditionally returned	Link to the PDF version of the file.	A valid URL
tracking_token	string	Conditionally returned	Unique identifier used to acknowledge that the file has been disclosed to the applicant. If the file was already disclosed, a null value is returned. NOTE: The tracking token is only valid for 14 calendar days.	255 char max

Sample response body

JSON

{
  "file_type": "NOAA",
  "links": {
    "json": "https://url.com/link_to_json_file",
    "html": "https://url.com/link_to_html_file",
    "pdf": "https://url.com/link_to_pdf_file"
  },
  "tracking_token": "tracking_token_Cf7xNsl6vGtHn%2BcTH96zdf"
}

​Create application

​Request body

​Sample request body

​Response body

​Sample response body

​Retrieve application

​URL path parameters

​URL query parameters

​Response body

​Sample response body

​Transition application state

​URL path parameters

​Request body

​Sample request body

​Response body

​Sample response body

​List application transitions

​URL path parameters

​Response body

​List files on a bundle or application

​URL query parameters

​Response body

​Sample response body

​Retrieve file on a bundle or application

​URL path parameters

​URL query parameters

​Response body

​Sample response body

Create application

Request body

Sample request body

Response body

Sample response body

Retrieve application

URL path parameters

URL query parameters

Response body

Sample response body

Transition application state

URL path parameters

Request body

Sample request body

Response body

Sample response body

List application transitions

URL path parameters

Response body

List files on a bundle or application

URL query parameters

Response body

Sample response body

Retrieve file on a bundle or application

URL path parameters

URL query parameters

Response body

Sample response body