Control profiles

Creates a control profile and applies it to the specified target.

Create a control profile

Creates a control profile.

SecurityOAuth2: OAuth
Request
Request Body schema: application/json
required
name
required
string

Control profile name.

Responses
201

Control profile created successfully

401

Unauthorized

422

Invalid data was sent

500

Internal Server Error

503

Service Unavailable

post/issuing/controls/control-profiles
Request samples
application/json
{
  • "name": "Low Risk MCC Profile"
}
Response samples
application/json
{}

Get all control profiles

Retrieves a list of control profiles for the currently authenticated client, or for a specific card if a card ID is provided.

SecurityOAuth2: OAuth
Request
query Parameters
target_id
string (IssuingCardId) = 30 characters ^crd_[a-z0-9]{26}$

The card's unique identifier.

Example: target_id=crd_fa6psq242dcd6fdn5gifcq1491
Responses
200

Control profiles retrieved successfully

401

Unauthorized

404

Client not found

422

Invalid data was sent

500

Internal Server Error

get/issuing/controls/control-profiles
Request samples
Response samples
application/json
{
  • "control_profiles": [
    ]
}

Get control profile details

Retrieves the details of an existing control profile.

SecurityOAuth2: OAuth
Request
path Parameters
controlProfileId
required
string (IssuingControlProfileId) = 30 characters ^cpr_[a-z0-9]{26}$

The control profile's unique identifier.

Example: cpr_j4mvlui5qotufgvaeqwhvlbfna
Responses
200

Control profile retrieved successfully

401

Unauthorized

404

Control profile not found

500

Internal Server Error

get/issuing/controls/control-profiles/{controlProfileId}
Request samples
Response samples
application/json
{}

Update a control profile

Update the control profile

SecurityOAuth2: OAuth
Request
path Parameters
controlProfileId
required
string (IssuingControlProfileId) = 30 characters ^cpr_[a-z0-9]{26}$

The control profile's unique identifier.

Example: cpr_j4mvlui5qotufgvaeqwhvlbfna
Request Body schema: application/json
required
name
string <= 256 characters

The control profile name.

Responses
200

Control profile updated successfully

401

Unauthorized

404

Control profile not found

500

Internal Server Error

503

Service Unavailable

patch/issuing/controls/control-profiles/{controlProfileId}
Request samples
application/json
{
  • "name": "Low Risk MCC Profile"
}
Response samples
application/json
{}

Remove a control profile

Removes the control profile. A control profile cannot be removed if it is used by a control.

SecurityOAuth2: OAuth
Request
path Parameters
controlProfileId
required
string (IssuingControlProfileId) = 30 characters ^cpr_[a-z0-9]{26}$

The control profile's unique identifier.

Example: cpr_j4mvlui5qotufgvaeqwhvlbfna
Responses
200

Control profile deleted successfully

401

Unauthorized

404

Control profile not found

500

Internal Server Error

503

Service Unavailable

delete/issuing/controls/control-profiles/{controlProfileId}
Request samples

Add target to control profile

Adds a target to an existing control profile.

SecurityOAuth2: OAuth
Request
path Parameters
controlProfileId
required
string (IssuingControlProfileId) = 30 characters ^cpr_[a-z0-9]{26}$

The control profile's unique identifier.

Example: cpr_j4mvlui5qotufgvaeqwhvlbfna
targetId
required
string (IssuingTargetIdToAddToControlProfile) = 30 characters ^crd_[a-z0-9]{26}$

The ID of the card to apply the control profile to.

Example: crd_fa6psq42dcdd6fdn5gifcq1491
Responses
200

Target added successfully

401

Unauthorized

404

Control profile not found

500

Internal Server Error

post/issuing/controls/control-profiles/{controlProfileId}/add/{targetId}
Request samples
Response samples
application/json
{}

Remove target from control profile

Removes a target from an existing control profile.

SecurityOAuth2: OAuth
Request
path Parameters
controlProfileId
required
string (IssuingControlProfileId) = 30 characters ^cpr_[a-z0-9]{26}$

The control profile's unique identifier.

Example: cpr_j4mvlui5qotufgvaeqwhvlbfna
targetId
required
string (IssuingTargetIdToRemoveFromControlProfile) = 30 characters ^crd_[a-z0-9]{26}$

The ID of the card the control profile should no longer apply to.

Example: crd_fa6psq42dcdd6fdn5gifcq1491
Responses
200

Target removed successfully

401

Unauthorized

404

Control profile not found

500

Internal Server Error

post/issuing/controls/control-profiles/{controlProfileId}/remove/{targetId}
Request samples
Response samples
application/json
{}