# 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](https://increase.com/documentation/card-art-physical-cards).

[Events](https://increase.com/documentation/events.md) will be generated for this resource. The possible event categories are: `physical_card_profile.created` and `physical_card_profile.updated`.

## The Physical Card Profile object
### Example
```json
{
  "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. This will be missing until the image has been post-processed.

- `carrier_image_file_id` (string, nullable)
  The identifier of the File containing the physical card's carrier image. This will be missing until the image has been post-processed.

- `contact_phone` (string, nullable)
  A phone number the user can contact to receive support for their card.

- `created_at` (string)
  The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Card Profile was created.

- `creator` (enum)
  The creator of this Physical Card Profile.
  Cases:
  * `increase` (This Physical Card Profile was created by Increase.)
  * `user` (This Physical Card Profile was created by you.)

- `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. This will be missing until the image has been post-processed.

- `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](https://increase.com/documentation/idempotency-keys).

- `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.
  Cases:
  * `pending_creating` (The Card Profile has not yet been processed by Increase.)
  * `pending_reviewing` (The card profile is awaiting review by Increase.)
  * `rejected` (There is an issue with the Physical Card Profile preventing it from use.)
  * `pending_submitting` (The card profile is awaiting submission to the fulfillment provider.)
  * `active` (The Physical Card Profile has been submitted to the fulfillment provider and is ready to use.)
  * `archived` (The Physical Card Profile has been archived.)

- `type` (string)
  A constant representing the object's type. For this resource it will always be `physical_card_profile`.

## List Physical Card Profiles
GET /physical_card_profiles

### Example
```curl
curl \
  --url "${INCREASE_URL}/physical_card_profiles" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

- `status.in` (array of enums, optional)
  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`.
  Cases:
  * `pending_creating` (The Card Profile has not yet been processed by Increase.)
  * `pending_reviewing` (The card profile is awaiting review by Increase.)
  * `rejected` (There is an issue with the Physical Card Profile preventing it from use.)
  * `pending_submitting` (The card profile is awaiting submission to the fulfillment provider.)
  * `active` (The Physical Card Profile has been submitted to the fulfillment provider and is ready to use.)
  * `archived` (The Physical Card Profile has been archived.)

- `idempotency_key` (string, optional)
  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](https://increase.com/documentation/idempotency-keys).

### Returns a Physical Card Profile List object:
```json
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Create a Physical Card Profile
POST /physical_card_profiles

### Example
```curl
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"
  }'
```

### Body 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.

- `description` (string, required)
  A description you can use to identify the Card Profile.

- `front_image_file_id` (string, required)
  The identifier of the File containing the physical card's front image.

- `front_text` (dictionary, optional)
  Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.

  - `front_text.line1` (string, required)
    The first line of text on the front of the card.

  - `front_text.line2` (string, optional)
    The second line of text on the front of the card. Providing a second line moves the first line slightly higher and prints the second line in the spot where the first line would have otherwise been printed.

- `program_id` (string, required)
  The identifier for the Program that this Physical Card Profile falls under.

## Retrieve a Card Profile
GET /physical_card_profiles/{physical_card_profile_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `physical_card_profile_id` (string, required)
  The identifier of the Card Profile.

## Archive a Physical Card Profile
POST /physical_card_profiles/{physical_card_profile_id}/archive

### Example
```curl
curl -X "POST" \
  --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec/archive" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `physical_card_profile_id` (string, required)
  The identifier of the Physical Card Profile to archive.

## Clone a Physical Card Profile
POST /physical_card_profiles/{physical_card_profile_id}/clone

### Example
```curl
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"
  }'
```
### Path Parameters
- `physical_card_profile_id` (string, required)
  The identifier of the Physical Card Profile to clone.

### Body Parameters
- `carrier_image_file_id` (string, optional)
  The identifier of the File containing the physical card's carrier image.

- `contact_phone` (string, optional)
  A phone number the user can contact to receive support for their card.

- `description` (string, optional)
  A description you can use to identify the Card Profile.

- `front_image_file_id` (string, optional)
  The identifier of the File containing the physical card's front image.

- `front_text` (dictionary, optional)
  Text printed on the front of the card. Reach out to [support@increase.com](mailto:support@increase.com) for more information.

  - `front_text.line1` (string, required)
    The first line of text on the front of the card.

  - `front_text.line2` (string, optional)
    The second line of text on the front of the card. Providing a second line moves the first line slightly higher and prints the second line in the spot where the first line would have otherwise been printed.

- `program_id` (string, optional)
  The identifier of the Program to use for the cloned Physical Card Profile.