Retrieve a Physical Card Profile

Changed on
get/physical_card_profiles/{physical_card_profile_id}

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/physical_card_profiles/{physical_card_profile_id}
  • Auth
    HTTP bearer

Path parameters

physical_card_profile_idstring required

The identifier of the Card Profile.

Response

Physical Card Profile

back_image_file_idstring nullable required

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_idstring nullable required

The identifier of the File containing the physical card's carrier image. This will be missing until the image has been post-processed.

contact_phonestring nullable required

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

created_atstring date-time required

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

creator'increase' | 'user' required

The creator of this Physical Card Profile.

descriptionstring required

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

front_image_file_idstring nullable required

The identifier of the File containing the physical card's front image. This will be missing until the image has been post-processed.

idstring required

The Card Profile identifier.

idempotency_keystring nullable required

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_defaultboolean required

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

program_idstring required

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

status'pending_creating' | 'pending_reviewing' | 'rejected' | 'pending_submitting' | 'active' | 'archived' required

The status of the Physical Card Profile.

type'physical_card_profile' required

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

Example response

{
  "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"
}

Changes

  • d410a6abb15dRevision changes
    • info

      api operation id retrieve_a_card_profile removed and replaced with retrieve_a_physical_card_profile

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      added the required property to the response with the status