fix: route forward and identity clients to dedicated base URLs#207
Merged
Conversation
Per the AWS PrivateLink docs (https://www.checkout.com/docs/developer-resources/api/private-connections/aws-privatelink), the valid subdomain is the first eight characters of the client_id (alphanumeric only), optionally with the literal pl- prefix when calling through PrivateLink. Tighten the regex from RFC-1123-style hyphenated to ^(?:pl-)?[a-z0-9]+$ and update the test corpus: test-123 moves to the rejected list, pl-vkuhvk4v (the docs example) joins the accepted list, and pl-, foo-bar are added as rejected.
|
david-ruiz-cko
approved these changes
May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The forward service and the identity-verification services (AML screening, face authentication, ID document verification, applicants, identity verification) live on their own hosts in the swagger spec, not under
api.checkout.com. This PR adds dedicated URIs for both and routes the corresponding clients through them. It also tightens the subdomain validation regex to match the AWS PrivateLink prefix format documented at https://www.checkout.com/docs/developer-resources/api/private-connections/aws-privatelink —^(?:pl-)?[a-z0-9]+$(alphanumeric, optionally prefixed by the literalpl-).Changes
checkout_sdk/environment.py— addsforward_uriandidentity_uriparameters to theEnvironmentconstructor; populates sandbox/production valuescheckout_sdk/checkout_api.py— adds_forward_api_clientand_identity_api_clientfactories; routesforwardto forward URI; routesaml_screening,face_authentication,id_document_verification,applicants,identity_verificationto a single cached identityApiClientcheckout_sdk/environment_subdomain.py— tightens regex to^(?:pl-)?[a-z0-9]+$tests/checkout_configuration_test.py— updates subdomain corpus: removestest-123from accepted, addspl-vkuhvk4v(docs example), addstest-123/foo-bar/pl-to rejected; addstest_environment_sandbox_urls/test_environment_production_urlsAPI Reference
https://forward.checkout.com/https://forward.sandbox.checkout.com— forward service (POST /forward,GET /forward/{id},POST /forward/secrets,GET|POST|DELETE /forward/secrets/{name})https://identity-verification.checkout.com/https://identity-verification.sandbox.checkout.com— identity services (/applicants,/identity-verifications,/aml-verifications,/face-authentications,/id-document-verifications)https://pl-{prefix}.api.{sandbox.,}checkout.com— AWS PrivateLink subdomain formatBreaking changes
Environment.__init__signature adds two new positional parameters (forward_uri,identity_uri). Anyone constructingEnvironmentdirectly (rather than via theEnvironment.sandbox()/Environment.production()factories) must update.test-123orfoo-bar-bazare rejected. Only plain alphanumeric or the literal PrivateLink form (pl-{prefix}) are accepted.README
Not affected.