increase-test
POST/physical_card_profiles

Create a physical card profile

Creates a physical card profile containing artwork and support contact details for physical cards. Supply description, contact_phone, front_image_file_id, carrier_image_file_id, and program_id; the image files must meet the specified purposes, dimensions, and resolution.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Physical card profile details, including its program, artwork, and optional printed front text.

carrier_image_file_idstringrequired
The identifier of the File containing the physical card's carrier image. This must have `purpose: physical_card_carrier` and be a 2550x3300 pixel PNG with a density of 300 dots per inch (DPI).
contact_phonestringrequired
A phone number the user can contact to receive support for their card.
descriptionstringrequired
A description you can use to identify the Card Profile.
front_image_file_idstringrequired
The identifier of the File containing the physical card's front image. This must have `purpose: physical_card_front` and be a 2100x1344 pixel PNG with a density of 600 dots per inch (DPI).
front_textobjectoptional
Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.
program_idstringrequired
The identifier for the Program that this Physical Card Profile falls under.

3 status codes
200Returns the created physical card profile with its identifier, creation time, status, program, artwork file identifiers, and other profile details.
back_image_file_idstringrequired
The identifier of the File containing the physical card's back image. This will be missing until the image has been post-processed.
carrier_image_file_idstringrequired
The identifier of the File containing the physical card's carrier image. This will be missing until the image has been post-processed.
contact_phonestringrequired
A phone number the user can contact to receive support for their card.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Card Profile was created.
creatorstringrequired
The creator of this Physical Card Profile.
Allowed:increaseuser
descriptionstringrequired
A description you can use to identify the Physical Card Profile.
front_image_file_idstringrequired
The identifier of the File containing the physical card's front image. This will be missing until the image has been post-processed.
front_textobjectrequired
Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.
idstringrequired
The Card Profile identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
is_defaultbooleanrequired
Whether this Physical Card Profile is the default for all cards in its Increase group.
program_idstringrequired
The identifier for the Program this Physical Card Profile belongs to.
statusstringrequired
The status of the Physical Card Profile.
Allowed:pending_creatingpending_reviewingrejectedpending_submittingactivearchived
typestringrequired
A constant representing the object's type. For this resource it will always be `physical_card_profile`.
Allowed:physical_card_profile
4XXReturned when the request is invalid or cannot be processed.
5XXReturned when the service encounters an internal error.

Error handling

description, contact_phone, front_image_file_id, carrier_image_file_id, and program_id are required. description must be 1–200 characters, and contact_phone must be 1–32 characters. The front image must use the physical_card_front purpose and be a 2100 × 1344 PNG at 600 DPI; the carrier image must use physical_card_carrier and be a 2550 × 3300 PNG at 300 DPI. If you provide front_text, include line1; each line must be 1–33 characters.