> ## Documentation Index
> Fetch the complete documentation index at: https://turnkey-0e7c1f5b-traian-remove-eip-712-note.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Signup
> Onboard a new user.
export const NestedParam = ({parentKey, childKey, type, required, description, children}) => {
const fullKey = `${parentKey}.${childKey}`;
const anchorId = `body-${fullKey.replace(/\./g, '-')}`;
return
{parentKey}.
{childKey}
{type}
{required &&
required
}
{children &&
}
;
};
export const H3Bordered = ({text}) =>
{text}
;
POST
[https://authproxy.turnkey.com/v1/signup\_v2](https://authproxy.turnkey.com/v1/signup_v2)
Your Auth Proxy config ID, found in **Dashboard → AUTH**. See [Auth Proxy reference](/reference/auth-proxy) for setup.
userEmail field
userPhoneNumber field
userTag field
userName field
organizationName field
verificationToken field
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an API Key.
The public component of a cryptographic key pair used to sign messages and transactions.
Enum options: `API_KEY_CURVE_P256`, `API_KEY_CURVE_SECP256K1`, `API_KEY_CURVE_ED25519`
Optional window (in seconds) indicating how long the API Key should last.
A list of Authenticator parameters. This field, if not needed, should be an empty array in your request body.
Human-readable name for an Authenticator.
Challenge presented for authentication purposes.
attestation field
The cbor encoded then base64 url encoded id of the credential.
A base64 url encoded payload containing metadata about the signing context and the challenge.
A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.
Enum options: `AUTHENTICATOR_TRANSPORT_BLE`, `AUTHENTICATOR_TRANSPORT_INTERNAL`, `AUTHENTICATOR_TRANSPORT_NFC`, `AUTHENTICATOR_TRANSPORT_USB`, `AUTHENTICATOR_TRANSPORT_HYBRID`
A list of Oauth providers. This field, if not needed, should be an empty array in your request body.
Human-readable name to identify a Provider.
Base64 encoded OIDC token
oidcClaims field
The issuer identifier from the OIDC token (iss claim)
The subject identifier from the OIDC token (sub claim)
The audience from the OIDC token (aud claim)
wallet field
Human-readable name for a Wallet.
A list of wallet Accounts. This field, if not needed, should be an empty array in your request body.
Enum options: `CURVE_SECP256K1`, `CURVE_ED25519`, `CURVE_P256`
Enum options: `PATH_FORMAT_BIP32`
Path used to generate a wallet Account.
Enum options: `ADDRESS_FORMAT_UNCOMPRESSED`, `ADDRESS_FORMAT_COMPRESSED`, `ADDRESS_FORMAT_ETHEREUM`, `ADDRESS_FORMAT_SOLANA`, `ADDRESS_FORMAT_COSMOS`, `ADDRESS_FORMAT_TRON`, `ADDRESS_FORMAT_SUI`, `ADDRESS_FORMAT_APTOS`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH`, `ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH`, `ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR`, `ADDRESS_FORMAT_SEI`, `ADDRESS_FORMAT_XLM`, `ADDRESS_FORMAT_DOGE_MAINNET`, `ADDRESS_FORMAT_DOGE_TESTNET`, `ADDRESS_FORMAT_TON_V3R2`, `ADDRESS_FORMAT_TON_V4R2`, `ADDRESS_FORMAT_TON_V5R1`, `ADDRESS_FORMAT_XRP`, `ADDRESS_FORMAT_SPARK_MAINNET`, `ADDRESS_FORMAT_SPARK_REGTEST`
Optional human-readable name for the account.
Length of mnemonic to generate the Wallet seed. Defaults to 12. Accepted values: 12, 15, 18, 21, 24.
clientSignature field
The public component of a cryptographic key pair used to create the signature.
Enum options: `CLIENT_SIGNATURE_SCHEME_API_P256`
The message that was signed.
The cryptographic signature over the message.
A successful response returns the following fields:
organizationId field
wallet field
walletId field
A list of account addresses.
item field
Root user ID created for this sub-organization
A list of App Proofs generated by enclaves during activity execution, providing verifiable attestations of performed operations.
scheme field
Enum options: `SIGNATURE_SCHEME_EPHEMERAL_KEY_P256`
Ephemeral public key.
JSON serialized AppProofPayload.
Signature over hashed proof\_payload.
```bash title="cURL" theme={null}
curl --request POST \
--url https://authproxy.turnkey.com/v1/signup_v2 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Auth-Proxy-Config-Id: (see Authorizations)" \
--data '{
"userEmail": "",
"userPhoneNumber": "",
"userTag": "",
"userName": "",
"organizationName": "",
"verificationToken": "",
"apiKeys": [
{
"apiKeyName": "",
"publicKey": "",
"curveType": "",
"expirationSeconds": ""
}
],
"authenticators": [
{
"authenticatorName": "",
"challenge": "",
"attestation": {
"credentialId": "",
"clientDataJson": "",
"attestationObject": "",
"transports": [
""
]
}
}
],
"oauthProviders": [
{
"providerName": "",
"oidcToken": "",
"oidcClaims": {
"iss": "",
"sub": "",
"aud": ""
}
}
],
"wallet": {
"walletName": "",
"accounts": [
{
"curve": "",
"pathFormat": "",
"path": "",
"addressFormat": "",
"name": ""
}
],
"mnemonicLength": ""
},
"clientSignature": {
"publicKey": "",
"scheme": "",
"message": "",
"signature": ""
}
}'
```
```json 200 theme={null}
{
"organizationId": "",
"wallet": {
"walletId": "",
"addresses": [
""
]
},
"userId": "",
"appProofs": [
{
"scheme": "",
"publicKey": "",
"proofPayload": "",
"signature": ""
}
]
}
```