Simulate that the Next Credential Scan Will Succeed

• Request Parameters

• Response

Simulates that the next attempt to scan a credential using the specified encoder will succeed. You can only perform this action within a sandbox workspace.

JavaScript

Simulates that the next attempt to scan a credential using the specified encoder will succeed.

Code

await seam.acs.encoders.simulate.nextCredentialScanWillSucceed({
  acs_encoder_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
  scenario: "credential_exists_on_seam",
  acs_credential_id_on_seam: "123e4567-e89b-12d3-a456-426614174000",
});

Output

// void

cURL

Simulates that the next attempt to scan a credential using the specified encoder will succeed.

Code

curl --include --request POST "https://connect.getseam.com/acs/encoders/simulate/next_credential_scan_will_succeed" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_encoder_id": "182ea706-8e14-4921-8e57-ee18d5a7de31",
  "scenario": "credential_exists_on_seam",
  "acs_credential_id_on_seam": "123e4567-e89b-12d3-a456-426614174000"
}
EOF

Output

{}

Python

Simulates that the next attempt to scan a credential using the specified encoder will succeed.

Code

seam.acs.encoders.simulate.next_credential_scan_will_succeed(
    acs_encoder_id="182ea706-8e14-4921-8e57-ee18d5a7de31",
    scenario="credential_exists_on_seam",
    acs_credential_id_on_seam="123e4567-e89b-12d3-a456-426614174000",
)

Output

None

Ruby

Simulates that the next attempt to scan a credential using the specified encoder will succeed.

Code

seam.acs.encoders.simulate.next_credential_scan_will_succeed(
  acs_encoder_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
  scenario: "credential_exists_on_seam",
  acs_credential_id_on_seam: "123e4567-e89b-12d3-a456-426614174000",
)

Output

nil

PHP

Simulates that the next attempt to scan a credential using the specified encoder will succeed.

Code

$seam->acs->encoders->simulate->next_credential_scan_will_succeed(
    acs_encoder_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
    scenario: "credential_exists_on_seam",
    acs_credential_id_on_seam: "123e4567-e89b-12d3-a456-426614174000"
);

Output

Seam CLI

Simulates that the next attempt to scan a credential using the specified encoder will succeed.

Code

seam acs encoders simulate next-credential-scan-will-succeed --acs_encoder_id "182ea706-8e14-4921-8e57-ee18d5a7de31" --scenario "credential_exists_on_seam" --acs_credential_id_on_seam "123e4567-e89b-12d3-a456-426614174000"

Output

{}

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

acs_encoder_id String (Required)

ID of the acs_encoder that will be used in the next request to scan the acs_credential.

---

acs_credential_id_on_seam String

ID of the Seam acs_credential that matches the acs_credential on the encoder in this simulation.

---

scenario String

Scenario to simulate.

---

Response

void