Verification
The verification resource allows you to send and verify SMS authentication codes. The following actions can be performed on this resource...
- Send Auth Code
- Verify Auth Code
Send Auth Code
Send a one-time SMS verification code to the specified phone number. This works in association with the Verify Auth Code endpoint to authenticate the phone number.
Any non-US phone numbers will not have verification codes sent to the number, but will still return a 200 Status Response. International numbers are currently created as contacts on Markit, but get moved into the invalid number status for now until proper international phone number support is added in the future.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
phoneNumber | string | Yes | - | The phone number of the recipient (US or non-US). Begin all phone numbers with a +. Ex: +1 234 567 8910 |
Example Response:
Verify Auth Code
Verify the one-time SMS verification code. Check if the input code matches the auth code that was sent to the specified phone number.
Any non-US phone numbers will not require verification codes to be verified as none is sent (see Send Auth Code). Any non-US number passed in will simply return a 200 Status Response. International numbers are currently created as contacts on Markit, but get moved into the invalid number status for now until proper international phone number support is added in the future.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
phoneNumber | string | Yes | - | The phone number of the recipient (US or non-US). Begin all phone numbers with a +. Ex: +1 234 567 8910 |
code | string | Yes | - | The 6-digit code entered by the user to verify against. |
Example Response: