fix: route forward and identity clients to dedicated base URLs#558
Open
armando-rodriguez-cko wants to merge 5 commits into
Open
fix: route forward and identity clients to dedicated base URLs#558armando-rodriguez-cko wants to merge 5 commits into
armando-rodriguez-cko wants to merge 5 commits into
Conversation
Cache the identity ApiClient instance once in the CheckoutApi constructor instead of constructing a new ApiClient (with its own HttpClient from the factory) inside each of the five identity clients. Behaviour unchanged; avoids redundant HttpClient allocations for the five clients that all target the same identity host.
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.
The .NET Regex constructor without an explicit timeout can hang indefinitely on pathological input. Pass a 100ms TimeSpan; the pattern itself is short and linear, so any execution exceeding that bound indicates a problem rather than legitimate matching.
david-ruiz-cko
previously approved these changes
May 12, 2026
Per the swagger spec, all identity endpoints (applicants, identity-verifications, aml-verifications, face-authentications, id-document-verifications) require the OAuth scope identity-verification. Expose it as a typed enum constant so OAuth clients can request it without hardcoding the string.
|
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 (applicants, identity-verification, AML screening, face-authentication, ID document 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-). Finally, it exposes theidentity-verificationOAuth scope as a typed enum constant and adds a 100ms timeout to the subdomain Regex (SonarLint S6444).Changes
src/CheckoutSdk/Environment.cs— addsForwardApiUriandIdentityApiUrito theSandbox/Production[Environment]attributes; tightens subdomain regex to^(?:pl-)?[a-z0-9]+$with a 100ms timeoutsrc/CheckoutSdk/EnvironmentAttribute.cs— addsForwardApiUri/IdentityApiUriproperties and constructor parameterssrc/CheckoutSdk/OAuthScope.cs— adds[OAuthScope("identity-verification")] IdentityVerificationsrc/CheckoutSdk/CheckoutApi.cs— addsForwardApiClientandIdentityApiClientfactory methods; routes_forwardClientto forward URI; caches the identityApiClientonce and reuses it across_applicantsClient,_amlScreeningClient,_faceAuthenticationClient,_idDocumentVerificationClient,_identityVerificationClient(avoids the .NET HttpClient anti-pattern of multiple instances per host)test/CheckoutSdkTest/CheckoutConfigurationTest.cs— updates subdomain corpus: removestest-123from accepted, addspl-vkuhvk4v(docs example) to accepted, addstest-123/foo-bar/pl-to rejected; addsShouldHaveCorrectForwardAndIdentityUrisForSandbox/…ForProductiontest/CheckoutSdkTest/SubdomainFunctionalityTest.cs— replaces the "invalid_subdomain" test value with one that's actually rejected (invalid_subdomain!); renames the hyphenated happy-path test toShouldAddSubdomainForPrivateLinkPrefixand uses the docs exampleAPI Reference
https://forward.checkout.com/https://forward.sandbox.checkout.com— forward service (POST /forward(beta),GET /forward/{id}(beta),POST /forward/secrets,GET|POST|DELETE /forward/secrets/{name}). Scopes:forward(plusforward:secretsfor secrets endpoints).https://identity-verification.checkout.com/https://identity-verification.sandbox.checkout.com— identity services (/applicants,/identity-verifications(beta),/aml-verifications(beta),/face-authentications(beta),/id-document-verifications(beta)). Scope:identity-verification.https://pl-{prefix}.api.{sandbox.,}checkout.com— AWS PrivateLink subdomain formatBreaking changes
EnvironmentAttributeconstructor now requiresforwardApiUriandidentityApiUristring parameters. Any code decorating a custom enum with[Environment(…)]must add them.test-123orfoo-bar-bazare rejected. Only plain alphanumeric or the literal PrivateLink form (pl-{prefix}) are accepted.README
Not affected.