Request body to create a new provider. The provider will be not enabled by default.

provider
enum<string>
required
Available options:
emailOnly,
magicLink,
apple,
bitbucket,
coinbasesocial,
discord,
epicgames,
facebook,
farcaster,
github,
gitlab,
google,
instagram,
linkedin,
microsoft,
twitch,
twitter,
blocto,
banxa,
dynamic,
alchemy,
zerodev,
telegram,
turnkey,
coinbaseWaas,
sms,
spotify,
tiktok,
line,
steam,
shopify
clientId
string

Standard OAuth client ID. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/. For Apple, this is also known as the Service ID.

clientSecret
string

Standard OAuth client secret key. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

providerProjectId
string

Some providers require additional information, typically called a project ID or site ID

defaultChainId
integer

The default chain id the SDK should use

defaultChain
string

CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)

Required string length: 5 - 41
keyExportUrl
string

The url of the site to go to export wallets private keys

termsUrl
string

The url of the terms and conditions or privacy policy needed to be shown to the client when creating a new provider that requires terms and conditions to be signed before starting configuration.

useDynamicCredentials
boolean
scopes
string

Optional custom space-delimited list of Oauth scopes for the social provider

appleKeyId
string

Key ID required for Apple Oauth2 applications. This is the identifier for a private key.

appleTeamId
string

Team ID required for Apple Oauth2 applications. This is associated with the Apple developer membership account.

accountSid
string

Required to initialize Twilio provider.

twilioNumber
string

Required to initialize Twilio provider. Phone number used to send SMS messages.

enabledCountries
object[]
multichainAccountAbstractionProviders
object[]

Was this page helpful?

ProviderAgreementProviderEnum