> ## 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. # Create user > Creates a new user with the provided details. Requires terms acceptance for compliance. Phone number must be unique within the project. In `CORPORATE` mode, `companyId` is required. ## OpenAPI ````yaml /api-reference/openapi.json post /users/ 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/: post: tags: - Users summary: Create user description: >- Creates a new user with the provided details. Requires terms acceptance for compliance. Phone number must be unique within the project. In `CORPORATE` mode, `companyId` is required. operationId: create_users parameters: - name: Reap-Version in: header required: true schema: type: string enum: - '2025-02-14' description: API version (YYYY-MM-DD) example: '2025-02-14' requestBody: description: Request body for creating a new user required: true content: application/json: schema: type: object properties: email: type: string maxLength: 50 format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ examples: - john.doe@partner.io description: User email address (max 50 characters) phoneNumber: type: string pattern: ^\+[1-9]\d{6,14}$ description: Phone number in E.164 format (e.g., +14155552671) examples: - '+14155552671' firstName: examples: - John description: >- User first name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted. type: string minLength: 1 maxLength: 100 lastName: examples: - Doe description: >- User last name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted. type: string minLength: 1 maxLength: 100 companyId: description: Company ID (required in `CORPORATE` program mode) type: string format: uuid termsAcceptance: type: object properties: version: type: string enum: - '2026-01-17' description: Version of terms being accepted example: '2026-01-17' ipAddress: anyOf: - type: string format: ipv4 pattern: >- ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$ - type: string format: ipv6 pattern: >- ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ description: IPv4 or IPv6 address examples: - 192.168.1.1 - '::1' required: - version - ipAddress description: Terms acceptance is required for compliance required: - email - phoneNumber - termsAcceptance application/x-www-form-urlencoded: schema: type: object properties: email: type: string maxLength: 50 format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ examples: - john.doe@partner.io description: User email address (max 50 characters) phoneNumber: type: string pattern: ^\+[1-9]\d{6,14}$ description: Phone number in E.164 format (e.g., +14155552671) examples: - '+14155552671' firstName: examples: - John description: >- User first name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted. type: string minLength: 1 maxLength: 100 lastName: examples: - Doe description: >- User last name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted. type: string minLength: 1 maxLength: 100 companyId: description: Company ID (required in `CORPORATE` program mode) type: string format: uuid termsAcceptance: type: object properties: version: type: string enum: - '2026-01-17' description: Version of terms being accepted example: '2026-01-17' ipAddress: anyOf: - type: string format: ipv4 pattern: >- ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$ - type: string format: ipv6 pattern: >- ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ description: IPv4 or IPv6 address examples: - 192.168.1.1 - '::1' required: - version - ipAddress description: Terms acceptance is required for compliance required: - email - phoneNumber - termsAcceptance multipart/form-data: schema: type: object properties: email: type: string maxLength: 50 format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ examples: - john.doe@partner.io description: User email address (max 50 characters) phoneNumber: type: string pattern: ^\+[1-9]\d{6,14}$ description: Phone number in E.164 format (e.g., +14155552671) examples: - '+14155552671' firstName: examples: - John description: >- User first name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted. type: string minLength: 1 maxLength: 100 lastName: examples: - Doe description: >- User last name (1-100 characters). Optional - auto-populated from the verified KYC identity on application approval if omitted. type: string minLength: 1 maxLength: 100 companyId: description: Company ID (required in `CORPORATE` program mode) type: string format: uuid termsAcceptance: type: object properties: version: type: string enum: - '2026-01-17' description: Version of terms being accepted example: '2026-01-17' ipAddress: anyOf: - type: string format: ipv4 pattern: >- ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$ - type: string format: ipv6 pattern: >- ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ description: IPv4 or IPv6 address examples: - 192.168.1.1 - '::1' required: - version - ipAddress description: Terms acceptance is required for compliance required: - email - phoneNumber - termsAcceptance responses: '200': description: User resource content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Response for status 400 content: application/json: schema: anyOf: - type: object properties: error: type: object properties: code: type: string const: PHONE_NUMBER_ALREADY_EXISTS message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: PhoneNumberAlreadyExistsError description: >- A user with this phone number already exists in the project - type: object properties: error: type: object properties: code: type: string const: INVALID_PHONE_NUMBER message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: InvalidPhoneNumberError description: Phone number is not a valid E.164 number - type: object properties: error: type: object properties: code: type: string const: INVALID_EMAIL_DOMAIN message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: InvalidEmailDomainError description: >- Email uses a reserved or non-routable top-level domain (e.g. .test, .example, .invalid, .localhost) - type: object properties: error: type: object properties: code: type: string const: COMPANY_ID_REQUIRED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: CompanyIdRequiredError description: companyId is required in Corporate program mode - type: object properties: error: type: object properties: code: type: string const: COMPANY_ID_NOT_ALLOWED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: CompanyIdNotAllowedError description: companyId is not allowed in Consumer program mode - type: object properties: error: type: object properties: code: type: string const: USER_COMPANY_NOT_FOUND message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: UserCompanyNotFoundError description: The specified company does not exist '409': description: >- The maximum number of users allowed for this project has been reached content: application/json: schema: type: object properties: error: type: object properties: code: type: string const: USER_QUOTA_EXCEEDED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: UserQuotaExceededError components: schemas: User: type: object properties: id: type: string format: uuid description: Unique user identifier email: 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,}$ examples: - john.doe@example.com description: User email address phoneNumber: type: string examples: - '+14155552671' description: Phone number in E.164 format firstName: anyOf: - type: string - type: 'null' examples: - John description: >- User first name. Null until provided by the client or backfilled from the verified KYC identity on approval. lastName: anyOf: - type: string - type: 'null' examples: - Doe description: >- User last name. Null until provided by the client or backfilled from the verified KYC identity on approval. country: anyOf: - type: string minLength: 2 maxLength: 2 examples: - US - GB - DE description: ISO 3166-1 alpha-2 country code - type: 'null' dateOfBirth: anyOf: - type: string - type: 'null' examples: - '1990-05-15' description: Date of birth in YYYY-MM-DD format (populated from KYC) companyId: anyOf: - type: string format: uuid - type: 'null' description: Company ID (set in `CORPORATE` program mode) application: $ref: '#/components/schemas/UserApplication' createdAt: type: string examples: - '2024-01-15T10:30:00Z' description: ISO 8601 timestamp of creation updatedAt: type: string examples: - '2024-01-15T10:35:00Z' description: ISO 8601 timestamp of last update required: - id - email - phoneNumber - firstName - lastName - country - dateOfBirth - companyId - application - createdAt - updatedAt UserApplication: type: object properties: status: type: string enum: - NOT_STARTED - AWAITING_DOCUMENTS - IN_REVIEW - APPROVED - REJECTED - RETRY_REQUIRED description: Current KYC application status example: NOT_STARTED rejectionReason: anyOf: - type: string - type: 'null' description: >- Human-readable reason for rejection. Set when status is `REJECTED` or `RETRY_REQUIRED`, null otherwise. documents: anyOf: - type: array items: $ref: '#/components/schemas/UserApplicationDocument' - type: 'null' description: >- Supporting documents the application is waiting on, each with its upload state. Null when no document submission is pending. required: - status - rejectionReason - documents description: KYC application status 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 ````