> ## Documentation Index > Fetch the complete documentation index at: https://docs.reap.global/llms.txt > Use this file to discover all available pages before exploring further. # Advance the user application > Advances the user KYC application. Only valid while the application is in a pending state. Which verification method applies is fixed by your project configuration rather than chosen per request, and determines the request you send. With no body (Reap-run verification), Reap returns a provider SDK token in `nextAction` for the client to complete and approval arrives later via webhook. For an externally-completed verification (e.g. a Sumsub applicant share token), the submission is ingested synchronously and approves the user. For a full verified data pack, the response `nextAction` lists the supporting documents to upload via `POST /users/:id/application/documents`. Send an `Idempotency-Key` to safely retry without re-consuming a single-use share token. ## OpenAPI ````yaml /api-reference/openapi.json post /users/{id}/application openapi: 3.1.0 info: title: Reap API version: 1.0.0 description: Reap platform API servers: - url: https://sandbox.api.reap.global description: Sandbox - url: https://prod.api.reap.global description: Production security: - bearerAuth: [] tags: - name: Accounts - name: Activities - name: Card Designs - name: Card Shipments - name: Card Transactions - name: Cards - name: Companies - name: Crypto Deposits - name: Policies - name: Simulation - name: Users - name: Virtual Asset Postings - name: Virtual Assets - name: Webhooks paths: /users/{id}/application: post: tags: - Users summary: Advance the user application description: >- Advances the user KYC application. Only valid while the application is in a pending state. Which verification method applies is fixed by your project configuration rather than chosen per request, and determines the request you send. With no body (Reap-run verification), Reap returns a provider SDK token in `nextAction` for the client to complete and approval arrives later via webhook. For an externally-completed verification (e.g. a Sumsub applicant share token), the submission is ingested synchronously and approves the user. For a full verified data pack, the response `nextAction` lists the supporting documents to upload via `POST /users/:id/application/documents`. Send an `Idempotency-Key` to safely retry without re-consuming a single-use share token. operationId: initiateApplication_users parameters: - name: id in: path required: true schema: description: User ID type: string format: uuid - name: Reap-Version in: header required: true schema: type: string enum: - '2025-02-14' description: API version (YYYY-MM-DD) example: '2025-02-14' - name: Idempotency-Key in: header required: false schema: type: string minLength: 1 maxLength: 255 description: >- Unique key for safely retrying this request. Up to 255 characters; we recommend a UUIDv4. The first request executes and its response is cached; subsequent requests with the same key replay the cached response (24h retention). requestBody: description: >- How to advance the KYC application. The accepted methods depend on the project KYC integration mode; each method is a distinct variant selected by the `method` field. required: true content: application/json: schema: oneOf: - type: object properties: method: type: string const: MANAGED_KYC required: - method title: Managed KYC - type: object properties: method: type: string const: SUMSUB_TOKEN_SHARING token: type: string minLength: 1 examples: - _act-sbx-abc123-xyz789 description: Sumsub applicant share token required: - method - token title: Sumsub Token Sharing - type: object properties: method: type: string const: UNIVERSAL_KYC provider: type: object properties: name: type: string minLength: 1 description: >- Name of the KYC provider that performed the verification status: type: string enum: - APPROVED - REJECTED - WARNING - NOT_EXECUTED description: >- Overall verification outcome reported by the provider example: APPROVED data: type: array items: type: object additionalProperties: {} description: Raw verification result payload from the provider required: - name - status - data description: The verification the applicant completed identity: type: object properties: firstName: type: string minLength: 1 maxLength: 100 description: Given name middleName: description: Middle name type: string maxLength: 100 lastName: description: Family name type: string maxLength: 100 fullName: type: string minLength: 1 maxLength: 200 description: Full legal name as verified dateOfBirth: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ description: Date of birth (YYYY-MM-DD) nationality: description: Nationality type: string minLength: 2 maxLength: 2 examples: - US - GB - DE required: - firstName - fullName - dateOfBirth - nationality description: Verified identity of the applicant documents: type: object properties: idDocument: type: object properties: type: type: string enum: - PASSPORT - ID_CARD - DRIVERS_LICENCE - RESIDENCE_PERMIT description: Identity document type example: PASSPORT number: type: string minLength: 1 maxLength: 50 description: Document number as shown on the document country: description: Country that issued the document type: string minLength: 2 maxLength: 2 examples: - US - GB - DE issuingDate: description: >- Date the document was issued (YYYY-MM-DD), when available type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ expiryDate: description: >- Date the document expires (YYYY-MM-DD), when applicable type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - type - number - country description: Government-issued identity document proofOfAddress: type: object properties: type: type: string enum: - ID_CARD - DRIVERS_LICENCE - RESIDENCE_PERMIT - UTILITY_BILL - UTILITY_BILL2 description: Proof-of-address document type example: ID_CARD number: type: string minLength: 1 maxLength: 50 description: Document number as shown on the document country: description: Country that issued the document type: string minLength: 2 maxLength: 2 examples: - US - GB - DE issuingDate: description: >- Date the document was issued (YYYY-MM-DD), when available type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ expiryDate: description: >- Date the document expires (YYYY-MM-DD), when applicable type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - type - number - country description: Proof-of-address document required: - idDocument - proofOfAddress description: >- Metadata for the supporting documents uploaded separately address: type: object properties: country: description: Country type: string minLength: 2 maxLength: 2 examples: - US - GB - DE postCode: description: Postal or ZIP code type: string minLength: 1 maxLength: 20 street: description: Street type: string minLength: 1 maxLength: 200 town: description: Town or city type: string maxLength: 100 subStreet: description: Additional street line type: string maxLength: 200 state: description: State, province, or region type: string maxLength: 100 buildingName: description: Building name type: string maxLength: 100 flatNumber: description: Flat, unit, or apartment number type: string maxLength: 20 buildingNumber: description: Building or house number type: string maxLength: 20 formattedAddress: type: string minLength: 1 maxLength: 500 description: Full address as a single formatted line required: - country - formattedAddress description: Residential address of the applicant liveness: type: object properties: result: type: string enum: - APPROVED - REJECTED - WARNING - NOT_EXECUTED description: Liveness-check outcome example: APPROVED checkedAt: description: >- When the liveness check was performed (ISO 8601). Required unless the check was not executed. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - result description: Result of the applicant liveness check jurisdictionDetails: oneOf: - $ref: '#/components/schemas/MexicoJurisdictionDetails' title: MexicoJurisdictionDetails description: >- Jurisdiction-specific KYC data required for certain BIN countries required: - method - provider - identity - documents - address - liveness title: Universal KYC application/x-www-form-urlencoded: schema: oneOf: - type: object properties: method: type: string const: MANAGED_KYC required: - method title: Managed KYC - type: object properties: method: type: string const: SUMSUB_TOKEN_SHARING token: type: string minLength: 1 examples: - _act-sbx-abc123-xyz789 description: Sumsub applicant share token required: - method - token title: Sumsub Token Sharing - type: object properties: method: type: string const: UNIVERSAL_KYC provider: type: object properties: name: type: string minLength: 1 description: >- Name of the KYC provider that performed the verification status: type: string enum: - APPROVED - REJECTED - WARNING - NOT_EXECUTED description: >- Overall verification outcome reported by the provider example: APPROVED data: type: array items: type: object additionalProperties: {} description: Raw verification result payload from the provider required: - name - status - data description: The verification the applicant completed identity: type: object properties: firstName: type: string minLength: 1 maxLength: 100 description: Given name middleName: description: Middle name type: string maxLength: 100 lastName: description: Family name type: string maxLength: 100 fullName: type: string minLength: 1 maxLength: 200 description: Full legal name as verified dateOfBirth: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ description: Date of birth (YYYY-MM-DD) nationality: description: Nationality type: string minLength: 2 maxLength: 2 examples: - US - GB - DE required: - firstName - fullName - dateOfBirth - nationality description: Verified identity of the applicant documents: type: object properties: idDocument: type: object properties: type: type: string enum: - PASSPORT - ID_CARD - DRIVERS_LICENCE - RESIDENCE_PERMIT description: Identity document type example: PASSPORT number: type: string minLength: 1 maxLength: 50 description: Document number as shown on the document country: description: Country that issued the document type: string minLength: 2 maxLength: 2 examples: - US - GB - DE issuingDate: description: >- Date the document was issued (YYYY-MM-DD), when available type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ expiryDate: description: >- Date the document expires (YYYY-MM-DD), when applicable type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - type - number - country description: Government-issued identity document proofOfAddress: type: object properties: type: type: string enum: - ID_CARD - DRIVERS_LICENCE - RESIDENCE_PERMIT - UTILITY_BILL - UTILITY_BILL2 description: Proof-of-address document type example: ID_CARD number: type: string minLength: 1 maxLength: 50 description: Document number as shown on the document country: description: Country that issued the document type: string minLength: 2 maxLength: 2 examples: - US - GB - DE issuingDate: description: >- Date the document was issued (YYYY-MM-DD), when available type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ expiryDate: description: >- Date the document expires (YYYY-MM-DD), when applicable type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - type - number - country description: Proof-of-address document required: - idDocument - proofOfAddress description: >- Metadata for the supporting documents uploaded separately address: type: object properties: country: description: Country type: string minLength: 2 maxLength: 2 examples: - US - GB - DE postCode: description: Postal or ZIP code type: string minLength: 1 maxLength: 20 street: description: Street type: string minLength: 1 maxLength: 200 town: description: Town or city type: string maxLength: 100 subStreet: description: Additional street line type: string maxLength: 200 state: description: State, province, or region type: string maxLength: 100 buildingName: description: Building name type: string maxLength: 100 flatNumber: description: Flat, unit, or apartment number type: string maxLength: 20 buildingNumber: description: Building or house number type: string maxLength: 20 formattedAddress: type: string minLength: 1 maxLength: 500 description: Full address as a single formatted line required: - country - formattedAddress description: Residential address of the applicant liveness: type: object properties: result: type: string enum: - APPROVED - REJECTED - WARNING - NOT_EXECUTED description: Liveness-check outcome example: APPROVED checkedAt: description: >- When the liveness check was performed (ISO 8601). Required unless the check was not executed. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - result description: Result of the applicant liveness check jurisdictionDetails: oneOf: - $ref: '#/components/schemas/MexicoJurisdictionDetails' title: MexicoJurisdictionDetails description: >- Jurisdiction-specific KYC data required for certain BIN countries required: - method - provider - identity - documents - address - liveness title: Universal KYC multipart/form-data: schema: oneOf: - type: object properties: method: type: string const: MANAGED_KYC required: - method title: Managed KYC - type: object properties: method: type: string const: SUMSUB_TOKEN_SHARING token: type: string minLength: 1 examples: - _act-sbx-abc123-xyz789 description: Sumsub applicant share token required: - method - token title: Sumsub Token Sharing - type: object properties: method: type: string const: UNIVERSAL_KYC provider: type: object properties: name: type: string minLength: 1 description: >- Name of the KYC provider that performed the verification status: type: string enum: - APPROVED - REJECTED - WARNING - NOT_EXECUTED description: >- Overall verification outcome reported by the provider example: APPROVED data: type: array items: type: object additionalProperties: {} description: Raw verification result payload from the provider required: - name - status - data description: The verification the applicant completed identity: type: object properties: firstName: type: string minLength: 1 maxLength: 100 description: Given name middleName: description: Middle name type: string maxLength: 100 lastName: description: Family name type: string maxLength: 100 fullName: type: string minLength: 1 maxLength: 200 description: Full legal name as verified dateOfBirth: type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ description: Date of birth (YYYY-MM-DD) nationality: description: Nationality type: string minLength: 2 maxLength: 2 examples: - US - GB - DE required: - firstName - fullName - dateOfBirth - nationality description: Verified identity of the applicant documents: type: object properties: idDocument: type: object properties: type: type: string enum: - PASSPORT - ID_CARD - DRIVERS_LICENCE - RESIDENCE_PERMIT description: Identity document type example: PASSPORT number: type: string minLength: 1 maxLength: 50 description: Document number as shown on the document country: description: Country that issued the document type: string minLength: 2 maxLength: 2 examples: - US - GB - DE issuingDate: description: >- Date the document was issued (YYYY-MM-DD), when available type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ expiryDate: description: >- Date the document expires (YYYY-MM-DD), when applicable type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - type - number - country description: Government-issued identity document proofOfAddress: type: object properties: type: type: string enum: - ID_CARD - DRIVERS_LICENCE - RESIDENCE_PERMIT - UTILITY_BILL - UTILITY_BILL2 description: Proof-of-address document type example: ID_CARD number: type: string minLength: 1 maxLength: 50 description: Document number as shown on the document country: description: Country that issued the document type: string minLength: 2 maxLength: 2 examples: - US - GB - DE issuingDate: description: >- Date the document was issued (YYYY-MM-DD), when available type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ expiryDate: description: >- Date the document expires (YYYY-MM-DD), when applicable type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ required: - type - number - country description: Proof-of-address document required: - idDocument - proofOfAddress description: >- Metadata for the supporting documents uploaded separately address: type: object properties: country: description: Country type: string minLength: 2 maxLength: 2 examples: - US - GB - DE postCode: description: Postal or ZIP code type: string minLength: 1 maxLength: 20 street: description: Street type: string minLength: 1 maxLength: 200 town: description: Town or city type: string maxLength: 100 subStreet: description: Additional street line type: string maxLength: 200 state: description: State, province, or region type: string maxLength: 100 buildingName: description: Building name type: string maxLength: 100 flatNumber: description: Flat, unit, or apartment number type: string maxLength: 20 buildingNumber: description: Building or house number type: string maxLength: 20 formattedAddress: type: string minLength: 1 maxLength: 500 description: Full address as a single formatted line required: - country - formattedAddress description: Residential address of the applicant liveness: type: object properties: result: type: string enum: - APPROVED - REJECTED - WARNING - NOT_EXECUTED description: Liveness-check outcome example: APPROVED checkedAt: description: >- When the liveness check was performed (ISO 8601). Required unless the check was not executed. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - result description: Result of the applicant liveness check jurisdictionDetails: oneOf: - $ref: '#/components/schemas/MexicoJurisdictionDetails' title: MexicoJurisdictionDetails description: >- Jurisdiction-specific KYC data required for certain BIN countries required: - method - provider - identity - documents - address - liveness title: Universal KYC responses: '200': description: Application state after advancing content: application/json: schema: type: object properties: provider: examples: - sumsub deprecated: true description: >- Deprecated: use `nextAction.provider`. Populated only when `nextAction.type` is `PROVIDER_SDK`. type: string const: sumsub sdkToken: examples: - _act-sbx-abc123-xyz789 deprecated: true description: >- Deprecated: use `nextAction.sdkToken`. Populated only when `nextAction.type` is `PROVIDER_SDK`. type: string status: type: string enum: - NOT_STARTED - AWAITING_DOCUMENTS - IN_REVIEW - APPROVED - REJECTED - RETRY_REQUIRED description: Current KYC application status example: NOT_STARTED nextAction: anyOf: - $ref: '#/components/schemas/ApplicationNextAction' title: ApplicationNextAction - type: 'null' description: >- Action the client must take next, or `null` if none remains required: - status - nextAction '400': description: Response for status 400 content: application/json: schema: anyOf: - type: object properties: error: type: object properties: code: type: string const: INVALID_APPLICATION_STATUS message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: InvalidApplicationStatusError description: User application status does not allow this operation - type: object properties: error: type: object properties: code: type: string const: SUMSUB_TOKEN_INVALID message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: SumsubTokenInvalidError description: The Sumsub share token is invalid or has expired - type: object properties: error: type: object properties: code: type: string const: INVALID_JURISDICTION_DATA message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: InvalidJurisdictionDataError description: Jurisdiction data is invalid for this card program - type: object properties: error: type: object properties: code: type: string const: APPLICATION_SUBMISSION_REJECTED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: ApplicationSubmissionRejectedError description: The submitted application data was rejected '403': description: The requested verification method is not enabled for this project content: application/json: schema: type: object properties: error: type: object properties: code: type: string const: VERIFICATION_METHOD_NOT_ENABLED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: VerificationMethodNotEnabledError '404': description: User not found content: application/json: schema: type: object properties: error: type: object properties: code: type: string const: USER_NOT_FOUND message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: UserNotFoundError '409': description: Response for status 409 content: application/json: schema: anyOf: - type: object properties: error: type: object properties: code: type: string const: USER_APPLICATION_FINALIZING message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: UserApplicationFinalizingError description: >- The user's application is being finalized. Retry in a few seconds. - type: object properties: error: type: object properties: code: type: string const: SUMSUB_TOKEN_ALREADY_USED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: SumsubTokenAlreadyUsedError description: The Sumsub share token has already been used '422': description: Response for status 422 content: application/json: schema: anyOf: - type: object properties: error: type: object properties: code: type: string const: SUMSUB_APPLICANT_NOT_APPROVED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: SumsubApplicantNotApprovedError description: >- The Sumsub applicant is not approved and cannot be imported - type: object properties: error: type: object properties: code: type: string const: SUMSUB_TOKEN_LEVEL_MISMATCH message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: SumsubTokenLevelMismatchError description: >- The Sumsub share token does not match the required applicant level '503': description: Service is temporarily unavailable. Please retry. content: application/json: schema: type: object properties: error: type: object properties: code: type: string const: SERVICE_UNAVAILABLE message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: ServiceUnavailableError components: schemas: MexicoJurisdictionDetails: type: object properties: jurisdiction: type: string const: MX countryOfBirth: description: Country of birth type: string minLength: 2 maxLength: 2 examples: - US - GB - DE economicActivity: type: string minLength: 1 maxLength: 200 description: The applicant's occupation or economic activity authorityIdIssuer: type: string enum: - INE - SRE description: Issuer of the government identity document example: INE uboAttestation: type: boolean description: >- Whether the applicant has attested their ultimate beneficial ownership status phone: description: Contact phone number. Required for Mexican nationals. type: string minLength: 1 maxLength: 50 email: description: Contact email address. Required for Mexican nationals. type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ taxId: description: Mexican tax identifier (RFC). Required for Mexican nationals. type: string pattern: ^[A-Z]{4}\d{6}[A-Z0-9]{3}$ curp: description: >- Mexican population registry code (CURP). Required for Mexican nationals. type: string pattern: ^[A-Z0-9]{18}$ required: - jurisdiction - countryOfBirth - economicActivity - authorityIdIssuer - uboAttestation title: Mexico ApplicationNextAction: oneOf: - $ref: '#/components/schemas/ProviderSdkNextAction' title: ProviderSdk - $ref: '#/components/schemas/DocumentUploadNextAction' title: DocumentUpload description: Next action required from the client title: Application next action ProviderSdkNextAction: type: object properties: type: type: string const: PROVIDER_SDK provider: type: string enum: - SUMSUB example: SUMSUB sdkToken: type: string examples: - _act-sbx-abc123-xyz789 description: Token for initializing the provider verification widget required: - type - provider - sdkToken title: Provider SDK DocumentUploadNextAction: type: object properties: type: type: string const: DOCUMENT_UPLOAD documents: type: array items: $ref: '#/components/schemas/UserApplicationDocument' description: Supporting documents to upload, each with its current upload state required: - type - documents title: Document upload UserApplicationDocument: type: object properties: type: type: string enum: - IDENTITY - PROOF_OF_ADDRESS - CURP description: Supporting document category example: IDENTITY status: type: string enum: - PENDING - UPLOADED description: Upload state of this document example: PENDING required: - type - status description: A supporting document and its upload state securitySchemes: bearerAuth: type: http scheme: bearer description: API key as Bearer token ````