fix: route forward and identity clients to dedicated base URLs#209
Open
armando-rodriguez-cko wants to merge 5 commits into
Open
fix: route forward and identity clients to dedicated base URLs#209armando-rodriguez-cko wants to merge 5 commits into
armando-rodriguez-cko wants to merge 5 commits into
Conversation
Extends the forward/identity URI split to the AML screening, applicants, face authentication, ID document verification and identity verification clients that were added on master after the original fix. Adds IdentityUri to the Environment interface and CheckoutEnv, with https://identity-verification.{sandbox.,}checkout.com as defined in the swagger spec. Adds buildIdentityClient and wires the five clients through it. Mock, telemetry test, README example and configuration tests updated accordingly.
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
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 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-verifications, aml-verifications, face-authentications, id-document-verifications) 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 constant.Changes
configuration/environment.go— addsForwardUri()andIdentityUri()to theEnvironmentinterface; addsforwardUri/identityUrifields and getters onCheckoutEnv; extendsNewEnvironmentsignature with both URIs; adds sandbox/production values; tightens subdomain regex to^(?:pl-)?[a-z0-9]+$configuration/oauth_scopes.go— addsIdentityVerification = "identity-verification"nas/checkout_api.go— addsbuildForwardClientandbuildIdentityClienthelpers; routesapi.Forwardto the forward URL; caches the identityApiClientonce and reuses it acrossAmlScreening,Applicants,FaceAuthentication,IdDocumentVerification,IdentityVerificationmocks/environment_mock.go— addsForwardUri()andIdentityUri()stubstest/configuration_api_test.go— addspl-vkuhvk4v(docs example) andpl-abc123to the accepted subdomains; movestest-123to the rejected list and addsfoo-bar,pl-(bare); assertsForwardUri()/IdentityUri()on production env; addsTestShouldHaveCorrectSandboxUrls/TestShouldHaveCorrectProductionUrlscovering every URItest/telemetry_test.go— passes the new URIs to the mock environment factoryREADME.md— updates theNewEnvironmentexample to reflect the new signatureAPI 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
configuration.NewEnvironmentsignature now requiresforwardUriandidentityUriparametersconfiguration.Environmentinterface addsForwardUri()andIdentityUri()methods — custom implementations must add themtest-123orfoo-bar-bazare rejected. Only plain alphanumeric (vkuhvk4v) or the literal PrivateLink form (pl-vkuhvk4v) are accepted.README
Updated.