Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Physical Card Profiles

This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on physical card artwork.

The Physical Card Profile object
{
  "back_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "carrier_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "contact_phone": "+16505046304",
  "created_at": "2020-01-31T23:59:59Z",
  "creator": "user",
  "description": "Corporate logo card",
  "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "front_text": null,
  "id": "physical_card_profile_m534d5rn9qyy9ufqxoec",
  "idempotency_key": null,
  "is_default": false,
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "status": "active",
  "type": "physical_card_profile"
}
Attributes
back_image_file_id
string
Nullable

The identifier of the File containing the physical card's back image.

carrier_image_file_id
string
Nullable

The identifier of the File containing the physical card's carrier image.

contact_phone
string
Nullable

A phone number the user can contact to receive support for their card.

created_at
string

The ISO 8601 date and time at which the Card Dispute was created.

creator
enum

The creator of this Physical Card Profile.

description
string

A description you can use to identify the Physical Card Profile.

front_image_file_id
string
Nullable

The identifier of the File containing the physical card's front image.

id
string

The Card Profile identifier.

idempotency_key
string
Nullable

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.

is_default
boolean

Whether this Physical Card Profile is the default for all cards in its Increase group.

program_id
string

The identifier for the Program this Physical Card Profile belongs to.

status
enum

The status of the Physical Card Profile.

type
string

A constant representing the object's type. For this resource it will always be physical_card_profile.

List Physical Card Profiles
curl \
  --url "${INCREASE_URL}/physical_card_profiles" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter Physical Card Profiles for those with the specified statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Create a Physical Card Profile
curl -X "POST" \
  --url "${INCREASE_URL}/physical_card_profiles" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "carrier_image_file_id": "file_h6v7mtipe119os47ehlu",
    "contact_phone": "+16505046304",
    "description": "My Card Profile",
    "front_image_file_id": "file_o6aex13wm1jcc36sgcj1",
    "program_id": "program_i2v2os4mwza1oetokh9i"
  }'
Parameters
carrier_image_file_id
string
Required

The identifier of the File containing the physical card's carrier image.

contact_phone
string
Required

A phone number the user can contact to receive support for their card.

32 character maximum
description
string
Required

A description you can use to identify the Card Profile.

200 character maximum
front_image_file_id
string
Required

The identifier of the File containing the physical card's front image.

front_text
dictionary

Text printed on the front of the card. Reach out to support@increase.com for more information.

program_id
string
Required

The identifier for the Program that this Physical Card Profile falls under.

Retrieve a Card Profile
curl \
  --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
physical_card_profile_id
string
Required

The identifier of the Card Profile.

Archive a Physical Card Profile
curl -X "POST" \
  --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec/archive" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
physical_card_profile_id
string
Required

The identifier of the Physical Card Profile to archive.

Clone a Physical Card Profile
curl -X "POST" \
  --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec/clone" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "front_image_file_id": "file_o6aex13wm1jcc36sgcj1"
  }'
Parameters
physical_card_profile_id
string
Required

The identifier of the Physical Card Profile to clone.

carrier_image_file_id
string

The identifier of the File containing the physical card's carrier image.

contact_phone
string

A phone number the user can contact to receive support for their card.

32 character maximum
description
string

A description you can use to identify the Card Profile.

200 character maximum
front_image_file_id
string

The identifier of the File containing the physical card's front image.

front_text
dictionary

Text printed on the front of the card. Reach out to support@increase.com for more information.