Create a consumer application for a user

Creates a consumer application for a user. Can be used directly without calling the initiate endpoint first. Identity verification is handled through Sumsub share token, Persona share token, or by providing personal information through the API. The application goes through KYC review once created.

POST /issuing/applications/user

cURL

Using API

curl --request POST \
  --url https://api.rain.xyz/v1/issuing/applications/user \
  --header 'Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "2000-01-01",
  "nationalId": "123456789",
  "countryOfIssue": "US",
  "email": "[e-mail]",
  "phoneCountryCode": "1",
  "phoneNumber": "5555555555",
  "address": {
    "line1": "123 Main St",
    "city": "New York",
    "region": "NY",
    "postalCode": "10001",
    "countryCode": "US"
  },
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "ipAddress": "192.168.1.1",
  "occupation": "Software Developers",
  "annualSalary": "100000",
  "accountPurpose": "Personal spending",
  "expectedMonthlyVolume": "5000"
}'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "isActive": true,
  "applicationStatus": "approved",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "sourceKey": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postalCode": "<string>",
    "countryCode": "<string>",
    "line2": "<string>",
    "country": "<string>"
  },
  "phoneCountryCode": "1",
  "phoneNumber": "5555555555",
  "walletAddress": "<string>",
  "solanaAddress": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "applicationExternalVerificationLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationCompletionLink": {
    "url": "<string>",
    "params": {
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "applicationReason": "<string>"
}

Authorizations

Api-Key · string · header · required

Body

application/json

Application information for this user

Using API

Using Sumsub Share Token

Using Persona Share Token

The user looking to create an account - they must have a wallet, and their wallet will be an owner on their Rain smart contract

firstName · string · required

The person's first name

Maximum string length: 50

lastName · string · required

The person's last name

Maximum string length: 50

birthDate · string<date> · required

The person's birth date

Example:

"2000-01-01"

nationalId · string · required

The person's national id, 9-digit SSN if country of issue is US

countryOfIssue · string · required

The person's country of issue of their national id

Required string length: 2

email · string · required

The person's email address

address · object · required

The person's address

Show child attributes

ipAddress · string · required

This user's IP address

occupation · string · required

The user's occupation

annualSalary · string · required

The user's annual salary

accountPurpose · string · required

The purpose of the user's account

expectedMonthlyVolume · string · required

The amount of money the user expects to spend each month

id · string<uuid>

The initiated application's Rain ID, if an application was previously initiated for this user

phoneCountryCode · string

The user's phone country code

Required string length: 1 - 3

Pattern: ^[0-9]+$

Example:

"1"

phoneNumber · string

The user's phone number

Required string length: 1 - 15

Pattern: ^[0-9]+$

Example:

"5555555555"

walletAddress · string

This user's EVM address; either walletAddress or solanaAddress or stellarAddress is required if using a Rain-managed solution, but not required otherwise

Pattern: ^0x[0-9a-fA-F]{40}$

solanaAddress · string

This user's Solana address; either walletAddress or solanaAddress or stellarAddress is required if using a Rain-managed solution, but not required otherwise

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

stellarAddress · string

This user's Stellar address; either walletAddress or solanaAddress or stellarAddress is required if using a Rain-managed solution, but not required otherwise

Pattern: ^[GC][A-Z2-7]{55}$|^M[A-Z2-7]{68}$

chainId · string

If using external collateral contracts, the chain id of the user's external collateral contract; not required if using Rain's collateral contracts

contractAddress · string

If using external collateral contracts, the address of the user's external collateral contract; not required if using Rain's collateral contracts

Pattern: ^(0x[0-9a-fA-F]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$

sourceKey · string

Unique identifier for where this user is coming from

Required string length: 1 - 24

externalId · string

An optional tenant-defined identifier for this user. Must be unique within the tenant.

Required string length: 1 - 255

isTermsOfServiceAccepted · enum<boolean>

Optional. Whether the user has accepted the terms of service. If omitted, this defaults to true server-side.

Available options: true

hasExistingDocuments · boolean

Whether or not to use existing documents for additional verification

Response

200

application/json

Successful operation

id · string<uuid> · required

The user's unique identifier

firstName · string · required

The user's first name

Maximum string length: 50

lastName · string · required

The user's last name

Maximum string length: 50

email · string · required

The user's email address

isActive · boolean · required

Whether the user is active

applicationStatus · enum<string> · required

Available options: approved, pending, needsInformation, needsVerification, manualReview, denied, locked, canceled

companyId · string<uuid>

The id of the company that the user belongs to, if any

externalId · string

An optional tenant-defined identifier for this user. Must be unique within the tenant.

Required string length: 1 - 255

sourceKey · string

The source key associated with the user's team

Required string length: 1 - 24

address · object

The user's physical address

Show child attributes

phoneCountryCode · string

The user's phone country code

Required string length: 1 - 3

Pattern: ^[0-9]+$

Example:

"1"

phoneNumber · string

The user's phone number

Required string length: 1 - 15

Pattern: ^[0-9]+$

Example:

"5555555555"

walletAddress · string

The user's EVM wallet address

solanaAddress · string

The user's Solana wallet address

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

createdAt · string<date-time>

When the user was created

updatedAt · string<date-time>

When the user was last updated

applicationExternalVerificationLink · object · deprecated

The link to the external verification page for the application

Show child attributes

applicationCompletionLink · object

The link to the completion page for the application

Show child attributes

applicationReason · string

The reason for the application status