> ## Documentation Index
> Fetch the complete documentation index at: https://docs.request.network/llms.txt
> Use this file to discover all available pages before exploring further.

# Create compliance data for a user

> Checks compliance status and returns necessary URLs for completing compliance.



## OpenAPI

````yaml /api-reference/openapi.v2.json post /v2/payer
openapi: 3.0.0
info:
  title: Request Network API
  description: API for easily creating and paying Requests with Request Network.
  version: 0.13.0
  contact: {}
servers:
  - url: https://api.request.network
    description: Production server
  - url: https://api.stage.request.network
    description: Staging server
  - url: http://127.0.0.1:8080
    description: Local development server
security: []
tags:
  - name: V2/Request
    description: Core payment request operations (V2)
  - name: V2/Payments
    description: Payment search and management operations (V2)
  - name: V2/Payouts
    description: Pay a request without creating one first (V2)
  - name: V2/Payer
    description: Crypto-to-fiat payer management operations (V2)
  - name: V2/Currencies
    description: Currency operations (V2)
  - name: V2/Client IDs
    description: Client ID management (V2)
  - name: V2/Payee Destination
    description: Payee destination management (V2)
externalDocs:
  description: Request Network Docs
  url: https://docs.request.network/request-network-api
paths:
  /v2/payer:
    post:
      tags:
        - Payer
        - V2/Payer
      summary: Create compliance data for a user
      description: >-
        Checks compliance status and returns necessary URLs for completing
        compliance.
      operationId: PayerV2Controller_getComplianceData_v2
      parameters:
        - name: x-api-key
          in: header
          description: API key for authentication
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                clientUserId:
                  type: string
                  minLength: 1
                  description: Client User ID
                email:
                  type: string
                  format: email
                  description: Email
                firstName:
                  type: string
                  minLength: 1
                  description: First Name
                lastName:
                  type: string
                  minLength: 1
                  description: Last Name
                beneficiaryType:
                  type: string
                  enum:
                    - individual
                    - business
                companyName:
                  type: string
                  description: Company Name
                dateOfBirth:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                  description: Date of birth in YYYY-MM-DD format
                addressLine1:
                  type: string
                  minLength: 1
                  description: Address Line 1
                addressLine2:
                  type: string
                  description: Address Line 2
                city:
                  type: string
                  minLength: 1
                  description: City
                state:
                  type: string
                  minLength: 1
                  description: State
                postcode:
                  type: string
                  minLength: 1
                  description: Postcode
                country:
                  type: string
                  minLength: 2
                  maxLength: 2
                  description: Country
                nationality:
                  type: string
                  minLength: 2
                  maxLength: 2
                  description: Nationality
                phone:
                  type: string
                  pattern: ^\+?[1-9]\d{1,14}$
                  description: Phone in E.164 format
                ssn:
                  type: string
                  minLength: 1
                  description: Social Security Number
                sourceOfFunds:
                  type: string
                  description: Source of Funds
                businessActivity:
                  type: string
                  description: Business Activity
              required:
                - clientUserId
                - email
                - firstName
                - lastName
                - beneficiaryType
                - dateOfBirth
                - addressLine1
                - city
                - state
                - postcode
                - country
                - nationality
                - phone
                - ssn
            examples:
              individualBeneficiary:
                summary: Individual beneficiary compliance data
                value:
                  clientUserId: user-123
                  email: john.doe@example.com
                  firstName: John
                  lastName: Doe
                  beneficiaryType: individual
                  dateOfBirth: '1985-12-12'
                  addressLine1: 123 Main Street
                  city: New York
                  state: NY
                  postcode: '10001'
                  country: US
                  nationality: US
                  phone: '+12125551234'
                  ssn: 123-45-6789
              businessBeneficiary:
                summary: Business beneficiary compliance data
                value:
                  clientUserId: business-456
                  email: cfo@company.com
                  firstName: Jane
                  lastName: Smith
                  beneficiaryType: business
                  companyName: Acme Corporation Inc.
                  dateOfBirth: '1980-05-15'
                  addressLine1: 456 Business Ave
                  addressLine2: Suite 200
                  city: San Francisco
                  state: CA
                  postcode: '94102'
                  country: US
                  nationality: US
                  phone: '+14155552000'
                  ssn: 987-65-4321
                  sourceOfFunds: Business revenue from software services
                  businessActivity: Software development and consulting
      responses:
        '200':
          description: Compliance data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreementUrl:
                    type: string
                    format: uri
                  kycUrl:
                    type: string
                    format: uri
                  status:
                    type: object
                    properties:
                      agreementStatus:
                        type: string
                        enum:
                          - not_started
                          - completed
                      kycStatus:
                        type: string
                        enum:
                          - not_started
                          - completed
                    required:
                      - agreementStatus
                      - kycStatus
                  userId:
                    type: string
                    format: uuid
                required:
                  - status
              examples:
                success:
                  summary: Successful response
                  value:
                    agreementUrl: >-
                      https://core-api.pay.so/v1/public/agreements?email=john.doe%40example.com
                    kycUrl: https://sumsub.com/idensic/l/#/sbx_VvK9E9P2A23xQPoA
                    status:
                      agreementStatus: not_started
                      kycStatus: not_started
        '400':
          description: Invalid request data
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: number
                    example: 400
                  message:
                    type: string
                    example: Compliance is only required for off-ramp requests
                  error:
                    type: string
                    example: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Request not found
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: number
                    example: 404
                  message:
                    type: string
                    example: Request with payment reference pay-ref-123 not found
                  error:
                    type: string
                    example: Not Found
        '429':
          description: Too Many Requests

````