@globalscoutme/api-client 1.0.19 → 1.0.20

package/README.md

@@ -37,6 +37,7 @@ import {
   Achievements,
   Body,
   Index,
+  Kyc,
   Offers,
   Organizations,
   Clubs,
@@ -161,6 +162,20 @@ await Invitations.resendInvitation({ path: { id: 'invitation-uuid' } });
 await Invitations.deleteInvitation({ path: { id: 'invitation-uuid' } });
 await Invitations.acceptInvitation(); // called after Supabase auth callback
 
+// KYC — SmileID Enhanced Document Verification
+const kycResult = await Kyc.startKyc({
+  body: { country: 'GH', channel: 'web' },
+});
+// kycResult: { token, partnerId, jobId, status, retriesRemaining }
+// Pass token + partnerId to the SmileID web SDK widget to start document capture.
+// SmileID calls POST /kyc/webhook when done — status updates automatically.
+
+const kycStatus = await Kyc.getKycStatus({
+  path: { userId: supabaseAuthUuid },
+});
+// kycStatus: { status, retryCount, retriesRemaining }
+// status: 'pending' | 'in_progress' | 'approved' | 'rejected' | 'blocked'
+
 // Storage — get a signed upload URL, then PUT the file directly to Supabase Storage
 const { uploadUrl, token, path, bucket, expiresIn } =
   await Storage.createUploadUrl({

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Offers, type Options, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
-export type { AchievementCatalogDto, AuthMeResponseDto, BodyMeasurementResponseDto, CareerAchievementDto, ChallengeCatalogDto, ClientOptions, ClubResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, CreateBodyMeasurementDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateUploadUrlDto, CreateVideoDto, DashboardResponseDto, DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponse, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponse, DeleteApiInvitationsByIdResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponse, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponse, DeleteApiVideosByIdResponses, DivisionDto, DocumentResponseDto, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponse, GetApiAchievementsMeResponses, GetApiAchievementsResponse, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponse, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponse, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponse, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponse, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponse, GetApiTrainingGroupedResponses, GetApiTrainingResponse, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponse, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponse, GetApiVideosMeResponses, HeartbeatDto, HeartbeatResponseDto, IndexItemDto, InvitationResponseDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponse, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponse, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponse, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponse, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponse, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponse, PostApiInvitationsResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponse, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponse, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponse, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponse, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponse, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponse, PostApiStorageUploadUrlResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RegisterClubDto, RegisterClubResponseDto, SendInvitationRequestDto, SendMessageDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, } from './types.gen.js';
+export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Offers, type Options, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
+export type { AchievementCatalogDto, AuthMeResponseDto, BodyMeasurementResponseDto, CareerAchievementDto, ChallengeCatalogDto, ClientOptions, ClubResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, CreateBodyMeasurementDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateUploadUrlDto, CreateVideoDto, DashboardResponseDto, DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponse, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponse, DeleteApiInvitationsByIdResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponse, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponse, DeleteApiVideosByIdResponses, DivisionDto, DocumentResponseDto, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponse, GetApiAchievementsMeResponses, GetApiAchievementsResponse, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponse, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponse, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponse, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponse, GetApiKycStatusByUserIdResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponse, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponse, GetApiTrainingGroupedResponses, GetApiTrainingResponse, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponse, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponse, GetApiVideosMeResponses, HeartbeatDto, HeartbeatResponseDto, IndexItemDto, InvitationResponseDto, KycStatusDto, KycWebhookDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponse, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponse, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponse, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponse, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponse, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponse, PostApiInvitationsResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponse, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponse, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponse, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponse, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponse, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponse, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponse, PostApiStorageUploadUrlResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RegisterClubDto, RegisterClubResponseDto, SendInvitationRequestDto, SendMessageDto, StartKycRequestDto, StartKycResponseDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, WebhookPartnerParamsDto, } from './types.gen.js';
 export { client, type CreateClientConfig } from './client.gen.js';

package/dist/index.js

@@ -1,3 +1,3 @@
 // This file is auto-generated by @hey-api/openapi-ts
-export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Offers, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
+export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Offers, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
 export { client } from './client.gen.js';

package/dist/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client/index.js';
-import type { DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponses, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponses, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponses, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponses } from './types.gen.js';
+import type { DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponses, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponses, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponses, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponses } from './types.gen.js';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -101,6 +101,20 @@ export declare class Invitations extends HeyApiClient {
      */
     acceptInvitation<ThrowOnError extends boolean = false>(options?: Options<PostApiInvitationsAcceptData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiInvitationsAcceptResponses, unknown, ThrowOnError, "fields">;
 }
+export declare class Kyc extends HeyApiClient {
+    /**
+     * Start or resume a KYC verification job
+     */
+    startKyc<ThrowOnError extends boolean = false>(options: Options<PostApiKycStartData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycStartResponses, PostApiKycStartErrors, ThrowOnError, "fields">;
+    /**
+     * SmileID webhook — receives job results (public, signature-verified)
+     */
+    kycWebhook<ThrowOnError extends boolean = false>(options: Options<PostApiKycWebhookData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycWebhookResponses, PostApiKycWebhookErrors, ThrowOnError, "fields">;
+    /**
+     * Get KYC status for a user
+     */
+    getKycStatus<ThrowOnError extends boolean = false>(options: Options<GetApiKycStatusByUserIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiKycStatusByUserIdResponses, GetApiKycStatusByUserIdErrors, ThrowOnError, "fields">;
+}
 export declare class Training extends HeyApiClient {
     /**
      * Get training content grouped by category, top 3 per category
@@ -153,6 +167,8 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
     get storage(): Storage;
     private _invitations?;
     get invitations(): Invitations;
+    private _kyc?;
+    get kyc(): Kyc;
     private _training?;
     get training(): Training;
     private _videos?;

package/dist/sdk.gen.js

@@ -271,6 +271,40 @@ export class Invitations extends HeyApiClient {
         return (options?.client ?? this.client).post({ url: '/api/invitations/accept', ...options });
     }
 }
+export class Kyc extends HeyApiClient {
+    /**
+     * Start or resume a KYC verification job
+     */
+    startKyc(options) {
+        return (options.client ?? this.client).post({
+            url: '/api/kyc/start',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers,
+            },
+        });
+    }
+    /**
+     * SmileID webhook — receives job results (public, signature-verified)
+     */
+    kycWebhook(options) {
+        return (options.client ?? this.client).post({
+            url: '/api/kyc/webhook',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers,
+            },
+        });
+    }
+    /**
+     * Get KYC status for a user
+     */
+    getKycStatus(options) {
+        return (options.client ?? this.client).get({ url: '/api/kyc/status/{userId}', ...options });
+    }
+}
 export class Training extends HeyApiClient {
     /**
      * Get training content grouped by category, top 3 per category
@@ -356,6 +390,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
     get invitations() {
         return (this._invitations ?? (this._invitations = new Invitations({ client: this.client })));
     }
+    get kyc() {
+        return (this._kyc ?? (this._kyc = new Kyc({ client: this.client })));
+    }
     get training() {
         return (this._training ?? (this._training = new Training({ client: this.client })));
     }

package/dist/types.gen.d.ts

@@ -1163,6 +1163,68 @@ export type InvitationResponseDto = {
     expiresAt: string;
     acceptedAt?: string | null;
 };
+export type StartKycRequestDto = {
+    /**
+     * ISO 3166-1 alpha-2 country code
+     */
+    country: string;
+    /**
+     * Channel initiating the KYC flow
+     */
+    channel: 'web' | 'mobile';
+};
+export type StartKycResponseDto = {
+    /**
+     * Short-lived token to Initialize the SmileID SDK widget
+     */
+    token?: string | null;
+    /**
+     * SmileID partner ID — required by the SDK
+     */
+    partnerId: string;
+    /**
+     * SmileID job identifier
+     */
+    jobId?: string | null;
+    status: 'pending' | 'in_progress' | 'approved' | 'rejected' | 'blocked';
+    /**
+     * Number of retries left before the account is blocked
+     */
+    retriesRemaining: number;
+};
+export type WebhookPartnerParamsDto = {
+    /**
+     * Our job identifier echoed back by SmileID
+     */
+    job_id?: string;
+    user_id?: string;
+    job_type?: string;
+};
+export type KycWebhookDto = {
+    /**
+     * SmileID internal job ID
+     */
+    SmileJobID?: string;
+    PartnerParams?: WebhookPartnerParamsDto;
+    /**
+     * SmileID result code — 1220/1221 = approved, 2xxx = rejected
+     */
+    ResultCode?: string;
+    ResultText?: string;
+    /**
+     * ISO timestamp used in HMAC-SHA256 signature
+     */
+    timestamp: string;
+    /**
+     * HMAC-SHA256 signature for request authenticity
+     */
+    signature: string;
+};
+export type KycStatusDto = {
+    status: 'pending' | 'in_progress' | 'approved' | 'rejected' | 'blocked';
+    retryCount: number;
+    retriesRemaining: number;
+};
 export type TrainingContentListItemDto = {
     id: string;
     title: string;
@@ -1990,6 +2052,62 @@ export type PostApiInvitationsAcceptResponses = {
     204: void;
 };
 export type PostApiInvitationsAcceptResponse = PostApiInvitationsAcceptResponses[keyof PostApiInvitationsAcceptResponses];
+export type PostApiKycStartData = {
+    body: StartKycRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/kyc/start';
+};
+export type PostApiKycStartErrors = {
+    /**
+     * Invalid request
+     */
+    400: unknown;
+};
+export type PostApiKycStartResponses = {
+    200: StartKycResponseDto;
+};
+export type PostApiKycStartResponse = PostApiKycStartResponses[keyof PostApiKycStartResponses];
+export type PostApiKycWebhookData = {
+    body: KycWebhookDto;
+    path?: never;
+    query?: never;
+    url: '/api/kyc/webhook';
+};
+export type PostApiKycWebhookErrors = {
+    /**
+     * Invalid signature
+     */
+    400: unknown;
+};
+export type PostApiKycWebhookResponses = {
+    /**
+     * Acknowledged
+     */
+    200: unknown;
+};
+export type GetApiKycStatusByUserIdData = {
+    body?: never;
+    path: {
+        userId: string;
+    };
+    query?: never;
+    url: '/api/kyc/status/{userId}';
+};
+export type GetApiKycStatusByUserIdErrors = {
+    /**
+     * Cannot access another user's KYC status
+     */
+    403: unknown;
+    /**
+     * No KYC record found
+     */
+    404: unknown;
+};
+export type GetApiKycStatusByUserIdResponses = {
+    200: KycStatusDto;
+};
+export type GetApiKycStatusByUserIdResponse = GetApiKycStatusByUserIdResponses[keyof GetApiKycStatusByUserIdResponses];
 export type GetApiTrainingGroupedData = {
     body?: never;
     path?: never;

package/index.ts

@@ -10,6 +10,7 @@ export {
   GlobalScoutMeClient,
   Index,
   Invitations,
+  Kyc,
   Offers,
   type Options,
   Organizations,
@@ -100,6 +101,10 @@ export type {
   GetApiInvitationsData,
   GetApiInvitationsResponse,
   GetApiInvitationsResponses,
+  GetApiKycStatusByUserIdData,
+  GetApiKycStatusByUserIdErrors,
+  GetApiKycStatusByUserIdResponse,
+  GetApiKycStatusByUserIdResponses,
   GetApiOffersConversationsByIdMessagesData,
   GetApiOffersConversationsByIdMessagesErrors,
   GetApiOffersConversationsByIdMessagesResponse,
@@ -152,6 +157,8 @@ export type {
   HeartbeatResponseDto,
   IndexItemDto,
   InvitationResponseDto,
+  KycStatusDto,
+  KycWebhookDto,
   MessageItemDto,
   MessageListResultDto,
   MessageSenderDto,
@@ -201,6 +208,13 @@ export type {
   PostApiInvitationsErrors,
   PostApiInvitationsResponse,
   PostApiInvitationsResponses,
+  PostApiKycStartData,
+  PostApiKycStartErrors,
+  PostApiKycStartResponse,
+  PostApiKycStartResponses,
+  PostApiKycWebhookData,
+  PostApiKycWebhookErrors,
+  PostApiKycWebhookResponses,
   PostApiOffersConversationsByIdMessagesData,
   PostApiOffersConversationsByIdMessagesErrors,
   PostApiOffersConversationsByIdMessagesResponse,
@@ -243,6 +257,8 @@ export type {
   RegisterClubResponseDto,
   SendInvitationRequestDto,
   SendMessageDto,
+  StartKycRequestDto,
+  StartKycResponseDto,
   TrainingCategoryGroupDto,
   TrainingContentDetailDto,
   TrainingContentListItemDto,
@@ -254,6 +270,7 @@ export type {
   UserAchievementResponseDto,
   VideoResponseDto,
   WatchingOrgDto,
+  WebhookPartnerParamsDto,
 } from './types.gen.js';
 
 export { client, type CreateClientConfig } from './client.gen.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalscoutme/api-client",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "description": "GlobalScoutMe API client (generated)",
   "author": "GlobalScoutMe",
   "license": "UNLICENSED",

package/sdk.gen.ts

@@ -50,6 +50,9 @@ import type {
   GetApiIndexCountriesResponses,
   GetApiInvitationsData,
   GetApiInvitationsResponses,
+  GetApiKycStatusByUserIdData,
+  GetApiKycStatusByUserIdErrors,
+  GetApiKycStatusByUserIdResponses,
   GetApiOffersConversationsByIdMessagesData,
   GetApiOffersConversationsByIdMessagesErrors,
   GetApiOffersConversationsByIdMessagesResponses,
@@ -112,6 +115,12 @@ import type {
   PostApiInvitationsData,
   PostApiInvitationsErrors,
   PostApiInvitationsResponses,
+  PostApiKycStartData,
+  PostApiKycStartErrors,
+  PostApiKycStartResponses,
+  PostApiKycWebhookData,
+  PostApiKycWebhookErrors,
+  PostApiKycWebhookResponses,
   PostApiOffersConversationsByIdMessagesData,
   PostApiOffersConversationsByIdMessagesErrors,
   PostApiOffersConversationsByIdMessagesResponses,
@@ -702,6 +711,61 @@ export class Invitations extends HeyApiClient {
   }
 }
 
+export class Kyc extends HeyApiClient {
+  /**
+   * Start or resume a KYC verification job
+   */
+  public startKyc<ThrowOnError extends boolean = false>(
+    options: Options<PostApiKycStartData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiKycStartResponses,
+      PostApiKycStartErrors,
+      ThrowOnError
+    >({
+      url: '/api/kyc/start',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * SmileID webhook — receives job results (public, signature-verified)
+   */
+  public kycWebhook<ThrowOnError extends boolean = false>(
+    options: Options<PostApiKycWebhookData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiKycWebhookResponses,
+      PostApiKycWebhookErrors,
+      ThrowOnError
+    >({
+      url: '/api/kyc/webhook',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Get KYC status for a user
+   */
+  public getKycStatus<ThrowOnError extends boolean = false>(
+    options: Options<GetApiKycStatusByUserIdData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).get<
+      GetApiKycStatusByUserIdResponses,
+      GetApiKycStatusByUserIdErrors,
+      ThrowOnError
+    >({ url: '/api/kyc/status/{userId}', ...options });
+  }
+}
+
 export class Training extends HeyApiClient {
   /**
    * Get training content grouped by category, top 3 per category
@@ -865,6 +929,11 @@ export class GlobalScoutMeClient extends HeyApiClient {
     return (this._invitations ??= new Invitations({ client: this.client }));
   }
 
+  private _kyc?: Kyc;
+  get kyc(): Kyc {
+    return (this._kyc ??= new Kyc({ client: this.client }));
+  }
+
   private _training?: Training;
   get training(): Training {
     return (this._training ??= new Training({ client: this.client }));

package/types.gen.ts

@@ -1229,6 +1229,73 @@ export type InvitationResponseDto = {
   acceptedAt?: string | null;
 };
 
+export type StartKycRequestDto = {
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Channel initiating the KYC flow
+   */
+  channel: 'web' | 'mobile';
+};
+
+export type StartKycResponseDto = {
+  /**
+   * Short-lived token to Initialize the SmileID SDK widget
+   */
+  token?: string | null;
+  /**
+   * SmileID partner ID — required by the SDK
+   */
+  partnerId: string;
+  /**
+   * SmileID job identifier
+   */
+  jobId?: string | null;
+  status: 'pending' | 'in_progress' | 'approved' | 'rejected' | 'blocked';
+  /**
+   * Number of retries left before the account is blocked
+   */
+  retriesRemaining: number;
+};
+
+export type WebhookPartnerParamsDto = {
+  /**
+   * Our job identifier echoed back by SmileID
+   */
+  job_id?: string;
+  user_id?: string;
+  job_type?: string;
+};
+
+export type KycWebhookDto = {
+  /**
+   * SmileID internal job ID
+   */
+  SmileJobID?: string;
+  PartnerParams?: WebhookPartnerParamsDto;
+  /**
+   * SmileID result code — 1220/1221 = approved, 2xxx = rejected
+   */
+  ResultCode?: string;
+  ResultText?: string;
+  /**
+   * ISO timestamp used in HMAC-SHA256 signature
+   */
+  timestamp: string;
+  /**
+   * HMAC-SHA256 signature for request authenticity
+   */
+  signature: string;
+};
+
+export type KycStatusDto = {
+  status: 'pending' | 'in_progress' | 'approved' | 'rejected' | 'blocked';
+  retryCount: number;
+  retriesRemaining: number;
+};
+
 export type TrainingContentListItemDto = {
   id: string;
   title: string;
@@ -2248,6 +2315,75 @@ export type PostApiInvitationsAcceptResponses = {
 export type PostApiInvitationsAcceptResponse =
   PostApiInvitationsAcceptResponses[keyof PostApiInvitationsAcceptResponses];
 
+export type PostApiKycStartData = {
+  body: StartKycRequestDto;
+  path?: never;
+  query?: never;
+  url: '/api/kyc/start';
+};
+
+export type PostApiKycStartErrors = {
+  /**
+   * Invalid request
+   */
+  400: unknown;
+};
+
+export type PostApiKycStartResponses = {
+  200: StartKycResponseDto;
+};
+
+export type PostApiKycStartResponse =
+  PostApiKycStartResponses[keyof PostApiKycStartResponses];
+
+export type PostApiKycWebhookData = {
+  body: KycWebhookDto;
+  path?: never;
+  query?: never;
+  url: '/api/kyc/webhook';
+};
+
+export type PostApiKycWebhookErrors = {
+  /**
+   * Invalid signature
+   */
+  400: unknown;
+};
+
+export type PostApiKycWebhookResponses = {
+  /**
+   * Acknowledged
+   */
+  200: unknown;
+};
+
+export type GetApiKycStatusByUserIdData = {
+  body?: never;
+  path: {
+    userId: string;
+  };
+  query?: never;
+  url: '/api/kyc/status/{userId}';
+};
+
+export type GetApiKycStatusByUserIdErrors = {
+  /**
+   * Cannot access another user's KYC status
+   */
+  403: unknown;
+  /**
+   * No KYC record found
+   */
+  404: unknown;
+};
+
+export type GetApiKycStatusByUserIdResponses = {
+  200: KycStatusDto;
+};
+
+export type GetApiKycStatusByUserIdResponse =
+  GetApiKycStatusByUserIdResponses[keyof GetApiKycStatusByUserIdResponses];
+
 export type GetApiTrainingGroupedData = {
   body?: never;
   path?: never;