@moonpay/platform-protocol 1.6.0 → 1.7.0

package/dist/api/customer.js

@@ -0,0 +1 @@
+//# sourceMappingURL=customer.js.map

package/dist/api/customer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/api/errors.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/api/errors.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\n// API errors\n// ---------------------------------------------------------------------------\n\nexport const DevPlatformApiErrorCodes = {\n  unknownError: 'unknown_error',\n  unauthorized: 'unauthorized',\n  forbidden: 'forbidden',\n  notFound: 'not_found',\n  invalidRequest: 'invalid_request',\n  notImplemented: 'not_implemented',\n  tooManyRequests: 'too_many_requests',\n  notAllowed: 'not_allowed',\n  conflict: 'conflict',\n  unprocessableEntity: 'unprocessable_entity',\n  sseTimeout: 'sse_timeout',\n  sseError: 'sse_error',\n  connectionRequired: 'connection_required',\n  connectionPending: 'connection_pending',\n  connectionUnavailable: 'connection_unavailable',\n  serviceUnavailable: 'service_unavailable',\n  requirementsIncomplete: 'requirements_incomplete',\n  verificationRejected: 'verification_rejected',\n  countryMismatch: 'country_mismatch',\n  unsupportedCountry: 'unsupported_country',\n} as const;\n\nexport type DevPlatformApiErrorCode =\n  (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];\n\nexport interface DevPlatformApiErrorDetail {\n  field?: string;\n  message: string;\n}\n\n/** Shape returned by the MoonPay Platform API on error responses. */\nexport interface DevPlatformApiError {\n  code: DevPlatformApiErrorCode;\n  message: string;\n  errors?: DevPlatformApiErrorDetail[];\n}\n\n// ---------------------------------------------------------------------------\n// API call result errors (all alias DevPlatformApiError)\n// ---------------------------------------------------------------------------\n\nexport type GetQuoteError = DevPlatformApiError;\nexport type GetAssetsError = DevPlatformApiError;\nexport type GetPaymentMethodsError = DevPlatformApiError;\nexport type GetTransactionsError = DevPlatformApiError;\nexport type CreateSessionError = DevPlatformApiError;\nexport type RevokeSessionError = DevPlatformApiError;\nexport type CreateIdentityError = DevPlatformApiError;\nexport type GetIdentityError = DevPlatformApiError;\nexport type UpdateIdentityError = DevPlatformApiError;\nexport type VerifyIdentityError = DevPlatformApiError;\nexport type GetIdentityUploadUrlError = DevPlatformApiError;\nexport type SubmitIdentityFilesError = DevPlatformApiError;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,IAAM,2BAA2B;AAAA,EACtC,cAAc;AAAA,EACd,cAAc;AAAA,EACd,WAAW;AAAA,EACX,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,qBAAqB;AAAA,EACrB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,oBAAoB;AAAA,EACpB,wBAAwB;AAAA,EACxB,sBAAsB;AAAA,EACtB,iBAAiB;AAAA,EACjB,oBAAoB;AACtB;","names":[]}
+{"version":3,"sources":["../../src/api/errors.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\n// API errors\n// ---------------------------------------------------------------------------\n\nexport const DevPlatformApiErrorCodes = {\n  unknownError: 'unknown_error',\n  unauthorized: 'unauthorized',\n  forbidden: 'forbidden',\n  notFound: 'not_found',\n  invalidRequest: 'invalid_request',\n  notImplemented: 'not_implemented',\n  tooManyRequests: 'too_many_requests',\n  notAllowed: 'not_allowed',\n  conflict: 'conflict',\n  unprocessableEntity: 'unprocessable_entity',\n  sseTimeout: 'sse_timeout',\n  sseError: 'sse_error',\n  connectionRequired: 'connection_required',\n  connectionPending: 'connection_pending',\n  connectionUnavailable: 'connection_unavailable',\n  serviceUnavailable: 'service_unavailable',\n  requirementsIncomplete: 'requirements_incomplete',\n  verificationRejected: 'verification_rejected',\n  countryMismatch: 'country_mismatch',\n  unsupportedCountry: 'unsupported_country',\n} as const;\n\nexport type DevPlatformApiErrorCode =\n  (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];\n\nexport interface DevPlatformApiErrorDetail {\n  field?: string;\n  message: string;\n}\n\n/** Shape returned by the MoonPay Platform API on error responses. */\nexport interface DevPlatformApiError {\n  code: DevPlatformApiErrorCode;\n  message: string;\n  errors?: DevPlatformApiErrorDetail[];\n}\n\n// ---------------------------------------------------------------------------\n// API call result errors (all alias DevPlatformApiError)\n// ---------------------------------------------------------------------------\n\nexport type GetQuoteError = DevPlatformApiError;\nexport type GetAssetsError = DevPlatformApiError;\nexport type GetPaymentMethodsError = DevPlatformApiError;\nexport type GetTransactionsError = DevPlatformApiError;\nexport type CreateSessionError = DevPlatformApiError;\nexport type RevokeSessionError = DevPlatformApiError;\n/** @deprecated Use the Customer API errors below instead. */\nexport type CreateIdentityError = DevPlatformApiError;\n/** @deprecated Use {@link GetCustomerError} instead. */\nexport type GetIdentityError = DevPlatformApiError;\n/** @deprecated Use {@link SubmitCustomerKycError} instead. */\nexport type UpdateIdentityError = DevPlatformApiError;\n/** @deprecated No longer needed — Customer API verification has no direct replacement call. */\nexport type VerifyIdentityError = DevPlatformApiError;\n/** @deprecated Use {@link GetCustomerUploadUrlError} instead. */\nexport type GetIdentityUploadUrlError = DevPlatformApiError;\n/** @deprecated Use {@link SubmitCustomerFilesError} instead. */\nexport type SubmitIdentityFilesError = DevPlatformApiError;\n\nexport type GetCustomerError = DevPlatformApiError;\nexport type SubmitCustomerKycError = DevPlatformApiError;\nexport type GetCustomerUploadUrlError = DevPlatformApiError;\nexport type SubmitCustomerFilesError = DevPlatformApiError;\nexport type ExportCustomerError = DevPlatformApiError;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAIO,IAAM,2BAA2B;AAAA,EACtC,cAAc;AAAA,EACd,cAAc;AAAA,EACd,WAAW;AAAA,EACX,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,qBAAqB;AAAA,EACrB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,oBAAoB;AAAA,EACpB,wBAAwB;AAAA,EACxB,sBAAsB;AAAA,EACtB,iBAAiB;AAAA,EACjB,oBAAoB;AACtB;","names":[]}

package/dist/api/errors.d.cts

@@ -37,11 +37,22 @@ type GetPaymentMethodsError = DevPlatformApiError;
 type GetTransactionsError = DevPlatformApiError;
 type CreateSessionError = DevPlatformApiError;
 type RevokeSessionError = DevPlatformApiError;
+/** @deprecated Use the Customer API errors below instead. */
 type CreateIdentityError = DevPlatformApiError;
+/** @deprecated Use {@link GetCustomerError} instead. */
 type GetIdentityError = DevPlatformApiError;
+/** @deprecated Use {@link SubmitCustomerKycError} instead. */
 type UpdateIdentityError = DevPlatformApiError;
+/** @deprecated No longer needed — Customer API verification has no direct replacement call. */
 type VerifyIdentityError = DevPlatformApiError;
+/** @deprecated Use {@link GetCustomerUploadUrlError} instead. */
 type GetIdentityUploadUrlError = DevPlatformApiError;
+/** @deprecated Use {@link SubmitCustomerFilesError} instead. */
 type SubmitIdentityFilesError = DevPlatformApiError;
+type GetCustomerError = DevPlatformApiError;
+type SubmitCustomerKycError = DevPlatformApiError;
+type GetCustomerUploadUrlError = DevPlatformApiError;
+type SubmitCustomerFilesError = DevPlatformApiError;
+type ExportCustomerError = DevPlatformApiError;
 
-export { type CreateIdentityError, type CreateSessionError, type DevPlatformApiError, type DevPlatformApiErrorCode, DevPlatformApiErrorCodes, type DevPlatformApiErrorDetail, type GetAssetsError, type GetIdentityError, type GetIdentityUploadUrlError, type GetPaymentMethodsError, type GetQuoteError, type GetTransactionsError, type RevokeSessionError, type SubmitIdentityFilesError, type UpdateIdentityError, type VerifyIdentityError };
+export { type CreateIdentityError, type CreateSessionError, type DevPlatformApiError, type DevPlatformApiErrorCode, DevPlatformApiErrorCodes, type DevPlatformApiErrorDetail, type ExportCustomerError, type GetAssetsError, type GetCustomerError, type GetCustomerUploadUrlError, type GetIdentityError, type GetIdentityUploadUrlError, type GetPaymentMethodsError, type GetQuoteError, type GetTransactionsError, type RevokeSessionError, type SubmitCustomerFilesError, type SubmitCustomerKycError, type SubmitIdentityFilesError, type UpdateIdentityError, type VerifyIdentityError };

package/dist/api/errors.d.ts

@@ -37,11 +37,22 @@ type GetPaymentMethodsError = DevPlatformApiError;
 type GetTransactionsError = DevPlatformApiError;
 type CreateSessionError = DevPlatformApiError;
 type RevokeSessionError = DevPlatformApiError;
+/** @deprecated Use the Customer API errors below instead. */
 type CreateIdentityError = DevPlatformApiError;
+/** @deprecated Use {@link GetCustomerError} instead. */
 type GetIdentityError = DevPlatformApiError;
+/** @deprecated Use {@link SubmitCustomerKycError} instead. */
 type UpdateIdentityError = DevPlatformApiError;
+/** @deprecated No longer needed — Customer API verification has no direct replacement call. */
 type VerifyIdentityError = DevPlatformApiError;
+/** @deprecated Use {@link GetCustomerUploadUrlError} instead. */
 type GetIdentityUploadUrlError = DevPlatformApiError;
+/** @deprecated Use {@link SubmitCustomerFilesError} instead. */
 type SubmitIdentityFilesError = DevPlatformApiError;
+type GetCustomerError = DevPlatformApiError;
+type SubmitCustomerKycError = DevPlatformApiError;
+type GetCustomerUploadUrlError = DevPlatformApiError;
+type SubmitCustomerFilesError = DevPlatformApiError;
+type ExportCustomerError = DevPlatformApiError;
 
-export { type CreateIdentityError, type CreateSessionError, type DevPlatformApiError, type DevPlatformApiErrorCode, DevPlatformApiErrorCodes, type DevPlatformApiErrorDetail, type GetAssetsError, type GetIdentityError, type GetIdentityUploadUrlError, type GetPaymentMethodsError, type GetQuoteError, type GetTransactionsError, type RevokeSessionError, type SubmitIdentityFilesError, type UpdateIdentityError, type VerifyIdentityError };
+export { type CreateIdentityError, type CreateSessionError, type DevPlatformApiError, type DevPlatformApiErrorCode, DevPlatformApiErrorCodes, type DevPlatformApiErrorDetail, type ExportCustomerError, type GetAssetsError, type GetCustomerError, type GetCustomerUploadUrlError, type GetIdentityError, type GetIdentityUploadUrlError, type GetPaymentMethodsError, type GetQuoteError, type GetTransactionsError, type RevokeSessionError, type SubmitCustomerFilesError, type SubmitCustomerKycError, type SubmitIdentityFilesError, type UpdateIdentityError, type VerifyIdentityError };

package/dist/api/errors.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/api/errors.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\n// API errors\n// ---------------------------------------------------------------------------\n\nexport const DevPlatformApiErrorCodes = {\n  unknownError: 'unknown_error',\n  unauthorized: 'unauthorized',\n  forbidden: 'forbidden',\n  notFound: 'not_found',\n  invalidRequest: 'invalid_request',\n  notImplemented: 'not_implemented',\n  tooManyRequests: 'too_many_requests',\n  notAllowed: 'not_allowed',\n  conflict: 'conflict',\n  unprocessableEntity: 'unprocessable_entity',\n  sseTimeout: 'sse_timeout',\n  sseError: 'sse_error',\n  connectionRequired: 'connection_required',\n  connectionPending: 'connection_pending',\n  connectionUnavailable: 'connection_unavailable',\n  serviceUnavailable: 'service_unavailable',\n  requirementsIncomplete: 'requirements_incomplete',\n  verificationRejected: 'verification_rejected',\n  countryMismatch: 'country_mismatch',\n  unsupportedCountry: 'unsupported_country',\n} as const;\n\nexport type DevPlatformApiErrorCode =\n  (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];\n\nexport interface DevPlatformApiErrorDetail {\n  field?: string;\n  message: string;\n}\n\n/** Shape returned by the MoonPay Platform API on error responses. */\nexport interface DevPlatformApiError {\n  code: DevPlatformApiErrorCode;\n  message: string;\n  errors?: DevPlatformApiErrorDetail[];\n}\n\n// ---------------------------------------------------------------------------\n// API call result errors (all alias DevPlatformApiError)\n// ---------------------------------------------------------------------------\n\nexport type GetQuoteError = DevPlatformApiError;\nexport type GetAssetsError = DevPlatformApiError;\nexport type GetPaymentMethodsError = DevPlatformApiError;\nexport type GetTransactionsError = DevPlatformApiError;\nexport type CreateSessionError = DevPlatformApiError;\nexport type RevokeSessionError = DevPlatformApiError;\nexport type CreateIdentityError = DevPlatformApiError;\nexport type GetIdentityError = DevPlatformApiError;\nexport type UpdateIdentityError = DevPlatformApiError;\nexport type VerifyIdentityError = DevPlatformApiError;\nexport type GetIdentityUploadUrlError = DevPlatformApiError;\nexport type SubmitIdentityFilesError = DevPlatformApiError;\n"],"mappings":";AAIO,IAAM,2BAA2B;AAAA,EACtC,cAAc;AAAA,EACd,cAAc;AAAA,EACd,WAAW;AAAA,EACX,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,qBAAqB;AAAA,EACrB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,oBAAoB;AAAA,EACpB,wBAAwB;AAAA,EACxB,sBAAsB;AAAA,EACtB,iBAAiB;AAAA,EACjB,oBAAoB;AACtB;","names":[]}
+{"version":3,"sources":["../../src/api/errors.ts"],"sourcesContent":["// ---------------------------------------------------------------------------\n// API errors\n// ---------------------------------------------------------------------------\n\nexport const DevPlatformApiErrorCodes = {\n  unknownError: 'unknown_error',\n  unauthorized: 'unauthorized',\n  forbidden: 'forbidden',\n  notFound: 'not_found',\n  invalidRequest: 'invalid_request',\n  notImplemented: 'not_implemented',\n  tooManyRequests: 'too_many_requests',\n  notAllowed: 'not_allowed',\n  conflict: 'conflict',\n  unprocessableEntity: 'unprocessable_entity',\n  sseTimeout: 'sse_timeout',\n  sseError: 'sse_error',\n  connectionRequired: 'connection_required',\n  connectionPending: 'connection_pending',\n  connectionUnavailable: 'connection_unavailable',\n  serviceUnavailable: 'service_unavailable',\n  requirementsIncomplete: 'requirements_incomplete',\n  verificationRejected: 'verification_rejected',\n  countryMismatch: 'country_mismatch',\n  unsupportedCountry: 'unsupported_country',\n} as const;\n\nexport type DevPlatformApiErrorCode =\n  (typeof DevPlatformApiErrorCodes)[keyof typeof DevPlatformApiErrorCodes];\n\nexport interface DevPlatformApiErrorDetail {\n  field?: string;\n  message: string;\n}\n\n/** Shape returned by the MoonPay Platform API on error responses. */\nexport interface DevPlatformApiError {\n  code: DevPlatformApiErrorCode;\n  message: string;\n  errors?: DevPlatformApiErrorDetail[];\n}\n\n// ---------------------------------------------------------------------------\n// API call result errors (all alias DevPlatformApiError)\n// ---------------------------------------------------------------------------\n\nexport type GetQuoteError = DevPlatformApiError;\nexport type GetAssetsError = DevPlatformApiError;\nexport type GetPaymentMethodsError = DevPlatformApiError;\nexport type GetTransactionsError = DevPlatformApiError;\nexport type CreateSessionError = DevPlatformApiError;\nexport type RevokeSessionError = DevPlatformApiError;\n/** @deprecated Use the Customer API errors below instead. */\nexport type CreateIdentityError = DevPlatformApiError;\n/** @deprecated Use {@link GetCustomerError} instead. */\nexport type GetIdentityError = DevPlatformApiError;\n/** @deprecated Use {@link SubmitCustomerKycError} instead. */\nexport type UpdateIdentityError = DevPlatformApiError;\n/** @deprecated No longer needed — Customer API verification has no direct replacement call. */\nexport type VerifyIdentityError = DevPlatformApiError;\n/** @deprecated Use {@link GetCustomerUploadUrlError} instead. */\nexport type GetIdentityUploadUrlError = DevPlatformApiError;\n/** @deprecated Use {@link SubmitCustomerFilesError} instead. */\nexport type SubmitIdentityFilesError = DevPlatformApiError;\n\nexport type GetCustomerError = DevPlatformApiError;\nexport type SubmitCustomerKycError = DevPlatformApiError;\nexport type GetCustomerUploadUrlError = DevPlatformApiError;\nexport type SubmitCustomerFilesError = DevPlatformApiError;\nexport type ExportCustomerError = DevPlatformApiError;\n"],"mappings":";AAIO,IAAM,2BAA2B;AAAA,EACtC,cAAc;AAAA,EACd,cAAc;AAAA,EACd,WAAW;AAAA,EACX,UAAU;AAAA,EACV,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,EAChB,iBAAiB;AAAA,EACjB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,qBAAqB;AAAA,EACrB,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,oBAAoB;AAAA,EACpB,mBAAmB;AAAA,EACnB,uBAAuB;AAAA,EACvB,oBAAoB;AAAA,EACpB,wBAAwB;AAAA,EACxB,sBAAsB;AAAA,EACtB,iBAAiB;AAAA,EACjB,oBAAoB;AACtB;","names":[]}

package/dist/api/identity.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/api/identity.ts"],"sourcesContent":["/**\n * Identity API types.\n *\n * Sourced from `moonpay-api/packages/dev-platform/modules/identity/main.tsp`.\n * The TypeSpec is marked `@vnext` and is not yet emitted into the public\n * OpenAPI spec, so these types are hand-rolled. Once the spec ships, replace\n * with aliases re-exported from `./gen/` (same pattern as `Quote`, `Identity`,\n * etc. in `api.ts`).\n */\n\n/** A platform capability a partner wants the customer to unlock. */\nexport type CapabilityProduct = 'ramps';\n\n/** A requested capability scoped to an identity. */\nexport interface IdentityCapability {\n  product: CapabilityProduct;\n}\n\n/** The state of an identity across the KYC lifecycle. */\nexport type IdentityStatus =\n  | 'created'\n  | 'collecting'\n  | 'verifying'\n  | 'challengeRequired'\n  | 'approved'\n  | 'rejected'\n  | 'manualReview'\n  | 'blocked';\n\n/** The completion state of a requirement item. */\nexport type RequirementItemStatus = 'incomplete' | 'complete';\n\n/** A field a customer must provide to fulfil a requirement. */\nexport type RequirementFieldName =\n  | 'firstName'\n  | 'lastName'\n  | 'dateOfBirth'\n  | 'nationality'\n  | 'street'\n  | 'locality'\n  | 'postalCode'\n  | 'country'\n  | 'administrativeArea'\n  | 'ssn'\n  | 'cpf'\n  | 'tin';\n\n/** Status of a single requirement group on an identity. */\nexport interface RequirementEntry {\n  status: RequirementItemStatus;\n  requiredFields?: RequirementFieldName[];\n}\n\n/** Outstanding and completed requirements for the identity, keyed by category. */\nexport interface Requirements {\n  basicDetails?: RequirementEntry;\n  residentialAddress?: RequirementEntry;\n  identityDocuments?: RequirementEntry;\n  selfie?: RequirementEntry;\n  taxIdentifiers?: RequirementEntry;\n  proofOfAddress?: RequirementEntry;\n  phoneNumber?: RequirementEntry;\n}\n\n/** Residential-address fields accepted at identity creation. */\nexport interface CreateIdentityResidentialAddress {\n  /** ISO 3166-1 alpha-3 country code declared by the partner. */\n  country: string;\n}\n\n/** Request body for creating an identity. */\nexport interface CreateIdentityRequestBody {\n  residentialAddress: CreateIdentityResidentialAddress;\n  /** Capabilities the partner wants the customer to unlock. Must contain at least one value. */\n  capabilities: IdentityCapability[];\n}\n\n/** Customer's basic personal details. */\nexport interface IdentityBasicDetailsSubmission {\n  firstName?: string;\n  lastName?: string;\n  nationality?: string;\n  /** YYYY-MM-DD. */\n  dateOfBirth?: string;\n}\n\n/** Customer's residential address. */\nexport interface IdentityResidentialAddressSubmission {\n  country?: string;\n  administrativeArea?: string;\n  locality?: string;\n  street?: string;\n  subStreet?: string;\n  postalCode?: string;\n}\n\n/** Customer's phone number in E.164 format. */\nexport interface IdentityPhoneNumberSubmission {\n  number: string;\n}\n\n/** Type of tax identifier the customer is submitting. */\nexport type IdentityTaxIdentifierType = 'tin' | 'ssn' | 'cpf';\n\n/** Tax Identification Number — country must be supplied. */\nexport interface IdentityTaxIdentifierGenericSubmission {\n  type: 'tin';\n  country: string;\n  value: string;\n}\n\n/** Country-specific tax identifier (SSN/CPF). */\nexport interface IdentityTaxIdentifierSchemeSubmission {\n  type: 'ssn' | 'cpf';\n  value: string;\n}\n\nexport type IdentityTaxIdentifierSubmission =\n  | IdentityTaxIdentifierGenericSubmission\n  | IdentityTaxIdentifierSchemeSubmission;\n\n/** Request body for updating an identity by submitting one or more requirements. */\nexport interface UpdateIdentityRequestBody {\n  residentialAddress?: IdentityResidentialAddressSubmission;\n  basicDetails?: IdentityBasicDetailsSubmission;\n  phoneNumber?: IdentityPhoneNumberSubmission;\n  taxIdentifiers?: IdentityTaxIdentifierSubmission[];\n}\n\n/** A MoonPay-hosted challenge a partner must surface to the customer. */\nexport interface IdentityVerificationChallenge {\n  /** Fully-formed challenge URL. */\n  url: string;\n  /** ISO 8601 expiry. */\n  expiresAt: string;\n}\n\n/** The state of an identity verification request. */\nexport type IdentityVerificationStatus = 'approved' | 'processing' | 'challengeRequired';\n\n/** Outcome of `POST /platform/v1/identities/{id}/verifications`. */\nexport type IdentityVerificationResponse =\n  | { status: 'approved' }\n  | { status: 'processing' }\n  | { status: 'challengeRequired'; challenge: IdentityVerificationChallenge };\n\n/** Type of identity-related file the customer is uploading. */\nexport type IdentityFileType =\n  | 'drivingLicence'\n  | 'nationalIdentityCard'\n  | 'passport'\n  | 'residencePermit'\n  | 'selfie'\n  | 'proofOfAddress';\n\n/** Side of a two-sided identity document. */\nexport type IdentityFileSide = 'front' | 'back';\n\n/** MIME type of the file being uploaded. */\nexport type IdentityFileMimeType = 'image/jpeg' | 'image/png' | 'application/pdf';\n\n/** Request body for issuing a presigned upload URL. */\nexport interface IdentityFileUploadUrlRequestBody {\n  fileType: IdentityFileType;\n  /** Required for two-sided file types (`drivingLicence`, `nationalIdentityCard`, `residencePermit`); omit for single-sided. */\n  side?: IdentityFileSide;\n  /** Must match the `Content-Type` header used on the subsequent upload request. */\n  mimeType: IdentityFileMimeType;\n}\n\n/** Headers the partner must send when uploading the file to the presigned URL. */\nexport interface IdentityFileUploadUrlHeaders {\n  'Content-Type': string;\n}\n\n/** Presigned URL the partner uses to upload an identity-related file. */\nexport interface IdentityFileUploadUrl {\n  uploadId: string;\n  url: string;\n  /** ISO 8601 expiry. */\n  expiresAt: string;\n  headers: IdentityFileUploadUrlHeaders;\n}\n\n/** A single uploaded file the partner is confirming for submission. */\nexport interface IdentityFileSubmission {\n  uploadId: string;\n  fileType: IdentityFileType;\n  side?: IdentityFileSide;\n}\n\n/** Request body for confirming one or more uploaded identity-related files. */\nexport interface SubmitIdentityFilesRequestBody {\n  files: IdentityFileSubmission[];\n}\n\n/** A KYC identity. */\nexport interface Identity {\n  id: string;\n  status: IdentityStatus;\n  capabilities: IdentityCapability[];\n  requirements: Requirements;\n  /** Present only when `status` is `challengeRequired`. */\n  challenge?: IdentityVerificationChallenge;\n  createdAt: string;\n  updatedAt: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../src/api/identity.ts"],"sourcesContent":["/**\n * Identity API types.\n *\n * @deprecated The Identity API is deprecated (DEVXP-1454) in favor of the\n * Customer API (`./customer.js`). Re-exported from the generated OpenAPI\n * types — see `./gen/index.js`.\n */\nexport type {\n  CapabilityProduct,\n  CreateIdentityRequestBody,\n  CreateIdentityResidentialAddress,\n  Identity,\n  IdentityBasicDetailsSubmission,\n  IdentityCapability,\n  IdentityFileMimeType,\n  IdentityFileSide,\n  IdentityFileSubmission,\n  IdentityFileType,\n  IdentityFileUploadUrl,\n  IdentityFileUploadUrlHeaders,\n  IdentityFileUploadUrlRequestBody,\n  IdentityPhoneNumberSubmission,\n  IdentityQuestionnaireSubmission,\n  IdentityResidentialAddressSubmission,\n  IdentityStatus,\n  IdentityTaxIdentifierGenericSubmission,\n  IdentityTaxIdentifierSchemeSubmission,\n  IdentityTaxIdentifierSubmission,\n  IdentityVerificationChallenge,\n  IdentityVerificationResponse,\n  IdentityVerificationStatus,\n  RequirementEntry,\n  RequirementFieldName,\n  RequirementItemStatus,\n  Requirements,\n  SubmitIdentityFilesRequestBody,\n  UpdateIdentityRequestBody,\n} from './gen/index.js';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/api/identity.d.cts

@@ -1,156 +1 @@
-/**
- * Identity API types.
- *
- * Sourced from `moonpay-api/packages/dev-platform/modules/identity/main.tsp`.
- * The TypeSpec is marked `@vnext` and is not yet emitted into the public
- * OpenAPI spec, so these types are hand-rolled. Once the spec ships, replace
- * with aliases re-exported from `./gen/` (same pattern as `Quote`, `Identity`,
- * etc. in `api.ts`).
- */
-/** A platform capability a partner wants the customer to unlock. */
-type CapabilityProduct = 'ramps';
-/** A requested capability scoped to an identity. */
-interface IdentityCapability {
-    product: CapabilityProduct;
-}
-/** The state of an identity across the KYC lifecycle. */
-type IdentityStatus = 'created' | 'collecting' | 'verifying' | 'challengeRequired' | 'approved' | 'rejected' | 'manualReview' | 'blocked';
-/** The completion state of a requirement item. */
-type RequirementItemStatus = 'incomplete' | 'complete';
-/** A field a customer must provide to fulfil a requirement. */
-type RequirementFieldName = 'firstName' | 'lastName' | 'dateOfBirth' | 'nationality' | 'street' | 'locality' | 'postalCode' | 'country' | 'administrativeArea' | 'ssn' | 'cpf' | 'tin';
-/** Status of a single requirement group on an identity. */
-interface RequirementEntry {
-    status: RequirementItemStatus;
-    requiredFields?: RequirementFieldName[];
-}
-/** Outstanding and completed requirements for the identity, keyed by category. */
-interface Requirements {
-    basicDetails?: RequirementEntry;
-    residentialAddress?: RequirementEntry;
-    identityDocuments?: RequirementEntry;
-    selfie?: RequirementEntry;
-    taxIdentifiers?: RequirementEntry;
-    proofOfAddress?: RequirementEntry;
-    phoneNumber?: RequirementEntry;
-}
-/** Residential-address fields accepted at identity creation. */
-interface CreateIdentityResidentialAddress {
-    /** ISO 3166-1 alpha-3 country code declared by the partner. */
-    country: string;
-}
-/** Request body for creating an identity. */
-interface CreateIdentityRequestBody {
-    residentialAddress: CreateIdentityResidentialAddress;
-    /** Capabilities the partner wants the customer to unlock. Must contain at least one value. */
-    capabilities: IdentityCapability[];
-}
-/** Customer's basic personal details. */
-interface IdentityBasicDetailsSubmission {
-    firstName?: string;
-    lastName?: string;
-    nationality?: string;
-    /** YYYY-MM-DD. */
-    dateOfBirth?: string;
-}
-/** Customer's residential address. */
-interface IdentityResidentialAddressSubmission {
-    country?: string;
-    administrativeArea?: string;
-    locality?: string;
-    street?: string;
-    subStreet?: string;
-    postalCode?: string;
-}
-/** Customer's phone number in E.164 format. */
-interface IdentityPhoneNumberSubmission {
-    number: string;
-}
-/** Type of tax identifier the customer is submitting. */
-type IdentityTaxIdentifierType = 'tin' | 'ssn' | 'cpf';
-/** Tax Identification Number — country must be supplied. */
-interface IdentityTaxIdentifierGenericSubmission {
-    type: 'tin';
-    country: string;
-    value: string;
-}
-/** Country-specific tax identifier (SSN/CPF). */
-interface IdentityTaxIdentifierSchemeSubmission {
-    type: 'ssn' | 'cpf';
-    value: string;
-}
-type IdentityTaxIdentifierSubmission = IdentityTaxIdentifierGenericSubmission | IdentityTaxIdentifierSchemeSubmission;
-/** Request body for updating an identity by submitting one or more requirements. */
-interface UpdateIdentityRequestBody {
-    residentialAddress?: IdentityResidentialAddressSubmission;
-    basicDetails?: IdentityBasicDetailsSubmission;
-    phoneNumber?: IdentityPhoneNumberSubmission;
-    taxIdentifiers?: IdentityTaxIdentifierSubmission[];
-}
-/** A MoonPay-hosted challenge a partner must surface to the customer. */
-interface IdentityVerificationChallenge {
-    /** Fully-formed challenge URL. */
-    url: string;
-    /** ISO 8601 expiry. */
-    expiresAt: string;
-}
-/** The state of an identity verification request. */
-type IdentityVerificationStatus = 'approved' | 'processing' | 'challengeRequired';
-/** Outcome of `POST /platform/v1/identities/{id}/verifications`. */
-type IdentityVerificationResponse = {
-    status: 'approved';
-} | {
-    status: 'processing';
-} | {
-    status: 'challengeRequired';
-    challenge: IdentityVerificationChallenge;
-};
-/** Type of identity-related file the customer is uploading. */
-type IdentityFileType = 'drivingLicence' | 'nationalIdentityCard' | 'passport' | 'residencePermit' | 'selfie' | 'proofOfAddress';
-/** Side of a two-sided identity document. */
-type IdentityFileSide = 'front' | 'back';
-/** MIME type of the file being uploaded. */
-type IdentityFileMimeType = 'image/jpeg' | 'image/png' | 'application/pdf';
-/** Request body for issuing a presigned upload URL. */
-interface IdentityFileUploadUrlRequestBody {
-    fileType: IdentityFileType;
-    /** Required for two-sided file types (`drivingLicence`, `nationalIdentityCard`, `residencePermit`); omit for single-sided. */
-    side?: IdentityFileSide;
-    /** Must match the `Content-Type` header used on the subsequent upload request. */
-    mimeType: IdentityFileMimeType;
-}
-/** Headers the partner must send when uploading the file to the presigned URL. */
-interface IdentityFileUploadUrlHeaders {
-    'Content-Type': string;
-}
-/** Presigned URL the partner uses to upload an identity-related file. */
-interface IdentityFileUploadUrl {
-    uploadId: string;
-    url: string;
-    /** ISO 8601 expiry. */
-    expiresAt: string;
-    headers: IdentityFileUploadUrlHeaders;
-}
-/** A single uploaded file the partner is confirming for submission. */
-interface IdentityFileSubmission {
-    uploadId: string;
-    fileType: IdentityFileType;
-    side?: IdentityFileSide;
-}
-/** Request body for confirming one or more uploaded identity-related files. */
-interface SubmitIdentityFilesRequestBody {
-    files: IdentityFileSubmission[];
-}
-/** A KYC identity. */
-interface Identity {
-    id: string;
-    status: IdentityStatus;
-    capabilities: IdentityCapability[];
-    requirements: Requirements;
-    /** Present only when `status` is `challengeRequired`. */
-    challenge?: IdentityVerificationChallenge;
-    createdAt: string;
-    updatedAt: string;
-}
-
-export type { CapabilityProduct, CreateIdentityRequestBody, CreateIdentityResidentialAddress, Identity, IdentityBasicDetailsSubmission, IdentityCapability, IdentityFileMimeType, IdentityFileSide, IdentityFileSubmission, IdentityFileType, IdentityFileUploadUrl, IdentityFileUploadUrlHeaders, IdentityFileUploadUrlRequestBody, IdentityPhoneNumberSubmission, IdentityResidentialAddressSubmission, IdentityStatus, IdentityTaxIdentifierGenericSubmission, IdentityTaxIdentifierSchemeSubmission, IdentityTaxIdentifierSubmission, IdentityTaxIdentifierType, IdentityVerificationChallenge, IdentityVerificationResponse, IdentityVerificationStatus, RequirementEntry, RequirementFieldName, RequirementItemStatus, Requirements, SubmitIdentityFilesRequestBody, UpdateIdentityRequestBody };
+export { C as CapabilityProduct, a as CreateIdentityRequestBody, b as CreateIdentityResidentialAddress, I as Identity, c as IdentityBasicDetailsSubmission, d as IdentityCapability, e as IdentityFileMimeType, f as IdentityFileSide, g as IdentityFileSubmission, h as IdentityFileType, i as IdentityFileUploadUrl, j as IdentityFileUploadUrlHeaders, k as IdentityFileUploadUrlRequestBody, l as IdentityPhoneNumberSubmission, m as IdentityQuestionnaireSubmission, n as IdentityResidentialAddressSubmission, o as IdentityStatus, p as IdentityTaxIdentifierGenericSubmission, q as IdentityTaxIdentifierSchemeSubmission, r as IdentityTaxIdentifierSubmission, s as IdentityVerificationChallenge, t as IdentityVerificationResponse, u as IdentityVerificationStatus, R as RequirementEntry, v as RequirementFieldName, w as RequirementItemStatus, x as Requirements, S as SubmitIdentityFilesRequestBody, U as UpdateIdentityRequestBody } from './customer.cjs';

package/dist/api/identity.d.ts

@@ -1,156 +1 @@
-/**
- * Identity API types.
- *
- * Sourced from `moonpay-api/packages/dev-platform/modules/identity/main.tsp`.
- * The TypeSpec is marked `@vnext` and is not yet emitted into the public
- * OpenAPI spec, so these types are hand-rolled. Once the spec ships, replace
- * with aliases re-exported from `./gen/` (same pattern as `Quote`, `Identity`,
- * etc. in `api.ts`).
- */
-/** A platform capability a partner wants the customer to unlock. */
-type CapabilityProduct = 'ramps';
-/** A requested capability scoped to an identity. */
-interface IdentityCapability {
-    product: CapabilityProduct;
-}
-/** The state of an identity across the KYC lifecycle. */
-type IdentityStatus = 'created' | 'collecting' | 'verifying' | 'challengeRequired' | 'approved' | 'rejected' | 'manualReview' | 'blocked';
-/** The completion state of a requirement item. */
-type RequirementItemStatus = 'incomplete' | 'complete';
-/** A field a customer must provide to fulfil a requirement. */
-type RequirementFieldName = 'firstName' | 'lastName' | 'dateOfBirth' | 'nationality' | 'street' | 'locality' | 'postalCode' | 'country' | 'administrativeArea' | 'ssn' | 'cpf' | 'tin';
-/** Status of a single requirement group on an identity. */
-interface RequirementEntry {
-    status: RequirementItemStatus;
-    requiredFields?: RequirementFieldName[];
-}
-/** Outstanding and completed requirements for the identity, keyed by category. */
-interface Requirements {
-    basicDetails?: RequirementEntry;
-    residentialAddress?: RequirementEntry;
-    identityDocuments?: RequirementEntry;
-    selfie?: RequirementEntry;
-    taxIdentifiers?: RequirementEntry;
-    proofOfAddress?: RequirementEntry;
-    phoneNumber?: RequirementEntry;
-}
-/** Residential-address fields accepted at identity creation. */
-interface CreateIdentityResidentialAddress {
-    /** ISO 3166-1 alpha-3 country code declared by the partner. */
-    country: string;
-}
-/** Request body for creating an identity. */
-interface CreateIdentityRequestBody {
-    residentialAddress: CreateIdentityResidentialAddress;
-    /** Capabilities the partner wants the customer to unlock. Must contain at least one value. */
-    capabilities: IdentityCapability[];
-}
-/** Customer's basic personal details. */
-interface IdentityBasicDetailsSubmission {
-    firstName?: string;
-    lastName?: string;
-    nationality?: string;
-    /** YYYY-MM-DD. */
-    dateOfBirth?: string;
-}
-/** Customer's residential address. */
-interface IdentityResidentialAddressSubmission {
-    country?: string;
-    administrativeArea?: string;
-    locality?: string;
-    street?: string;
-    subStreet?: string;
-    postalCode?: string;
-}
-/** Customer's phone number in E.164 format. */
-interface IdentityPhoneNumberSubmission {
-    number: string;
-}
-/** Type of tax identifier the customer is submitting. */
-type IdentityTaxIdentifierType = 'tin' | 'ssn' | 'cpf';
-/** Tax Identification Number — country must be supplied. */
-interface IdentityTaxIdentifierGenericSubmission {
-    type: 'tin';
-    country: string;
-    value: string;
-}
-/** Country-specific tax identifier (SSN/CPF). */
-interface IdentityTaxIdentifierSchemeSubmission {
-    type: 'ssn' | 'cpf';
-    value: string;
-}
-type IdentityTaxIdentifierSubmission = IdentityTaxIdentifierGenericSubmission | IdentityTaxIdentifierSchemeSubmission;
-/** Request body for updating an identity by submitting one or more requirements. */
-interface UpdateIdentityRequestBody {
-    residentialAddress?: IdentityResidentialAddressSubmission;
-    basicDetails?: IdentityBasicDetailsSubmission;
-    phoneNumber?: IdentityPhoneNumberSubmission;
-    taxIdentifiers?: IdentityTaxIdentifierSubmission[];
-}
-/** A MoonPay-hosted challenge a partner must surface to the customer. */
-interface IdentityVerificationChallenge {
-    /** Fully-formed challenge URL. */
-    url: string;
-    /** ISO 8601 expiry. */
-    expiresAt: string;
-}
-/** The state of an identity verification request. */
-type IdentityVerificationStatus = 'approved' | 'processing' | 'challengeRequired';
-/** Outcome of `POST /platform/v1/identities/{id}/verifications`. */
-type IdentityVerificationResponse = {
-    status: 'approved';
-} | {
-    status: 'processing';
-} | {
-    status: 'challengeRequired';
-    challenge: IdentityVerificationChallenge;
-};
-/** Type of identity-related file the customer is uploading. */
-type IdentityFileType = 'drivingLicence' | 'nationalIdentityCard' | 'passport' | 'residencePermit' | 'selfie' | 'proofOfAddress';
-/** Side of a two-sided identity document. */
-type IdentityFileSide = 'front' | 'back';
-/** MIME type of the file being uploaded. */
-type IdentityFileMimeType = 'image/jpeg' | 'image/png' | 'application/pdf';
-/** Request body for issuing a presigned upload URL. */
-interface IdentityFileUploadUrlRequestBody {
-    fileType: IdentityFileType;
-    /** Required for two-sided file types (`drivingLicence`, `nationalIdentityCard`, `residencePermit`); omit for single-sided. */
-    side?: IdentityFileSide;
-    /** Must match the `Content-Type` header used on the subsequent upload request. */
-    mimeType: IdentityFileMimeType;
-}
-/** Headers the partner must send when uploading the file to the presigned URL. */
-interface IdentityFileUploadUrlHeaders {
-    'Content-Type': string;
-}
-/** Presigned URL the partner uses to upload an identity-related file. */
-interface IdentityFileUploadUrl {
-    uploadId: string;
-    url: string;
-    /** ISO 8601 expiry. */
-    expiresAt: string;
-    headers: IdentityFileUploadUrlHeaders;
-}
-/** A single uploaded file the partner is confirming for submission. */
-interface IdentityFileSubmission {
-    uploadId: string;
-    fileType: IdentityFileType;
-    side?: IdentityFileSide;
-}
-/** Request body for confirming one or more uploaded identity-related files. */
-interface SubmitIdentityFilesRequestBody {
-    files: IdentityFileSubmission[];
-}
-/** A KYC identity. */
-interface Identity {
-    id: string;
-    status: IdentityStatus;
-    capabilities: IdentityCapability[];
-    requirements: Requirements;
-    /** Present only when `status` is `challengeRequired`. */
-    challenge?: IdentityVerificationChallenge;
-    createdAt: string;
-    updatedAt: string;
-}
-
-export type { CapabilityProduct, CreateIdentityRequestBody, CreateIdentityResidentialAddress, Identity, IdentityBasicDetailsSubmission, IdentityCapability, IdentityFileMimeType, IdentityFileSide, IdentityFileSubmission, IdentityFileType, IdentityFileUploadUrl, IdentityFileUploadUrlHeaders, IdentityFileUploadUrlRequestBody, IdentityPhoneNumberSubmission, IdentityResidentialAddressSubmission, IdentityStatus, IdentityTaxIdentifierGenericSubmission, IdentityTaxIdentifierSchemeSubmission, IdentityTaxIdentifierSubmission, IdentityTaxIdentifierType, IdentityVerificationChallenge, IdentityVerificationResponse, IdentityVerificationStatus, RequirementEntry, RequirementFieldName, RequirementItemStatus, Requirements, SubmitIdentityFilesRequestBody, UpdateIdentityRequestBody };
+export { C as CapabilityProduct, a as CreateIdentityRequestBody, b as CreateIdentityResidentialAddress, I as Identity, c as IdentityBasicDetailsSubmission, d as IdentityCapability, e as IdentityFileMimeType, f as IdentityFileSide, g as IdentityFileSubmission, h as IdentityFileType, i as IdentityFileUploadUrl, j as IdentityFileUploadUrlHeaders, k as IdentityFileUploadUrlRequestBody, l as IdentityPhoneNumberSubmission, m as IdentityQuestionnaireSubmission, n as IdentityResidentialAddressSubmission, o as IdentityStatus, p as IdentityTaxIdentifierGenericSubmission, q as IdentityTaxIdentifierSchemeSubmission, r as IdentityTaxIdentifierSubmission, s as IdentityVerificationChallenge, t as IdentityVerificationResponse, u as IdentityVerificationStatus, R as RequirementEntry, v as RequirementFieldName, w as RequirementItemStatus, x as Requirements, S as SubmitIdentityFilesRequestBody, U as UpdateIdentityRequestBody } from './customer.js';